From 73b1f2527942e5d787d72e704d2b64c04d168dd9 Mon Sep 17 00:00:00 2001 From: Ivo Oskamp Date: Sat, 7 Feb 2026 23:47:33 +0100 Subject: [PATCH] Add comprehensive TODO for documentation system Static documentation/user guide for BackupChecks application to help new users understand how the system works. Key Features: - Static HTML templates (no in-app editing) - Multi-page structure with sidebar navigation - 30+ documentation pages covering all features - Sections: Getting Started, Users, Customers/Jobs, Mail Import, Backup Review, Reports, Autotask, Settings, Troubleshooting - Screenshots with guidelines - Responsive design (mobile-friendly) - Access restricted to logged-in users - English only (app not translated) Structure: - Left sidebar with collapsible sections - Breadcrumb navigation - Previous/Next page navigation - Content area with max-width for readability - Callout boxes (info/warning/tip/danger) - Code blocks with syntax highlighting - Tables for settings/options - Image support with captions Implementation Phases: 1. Core infrastructure (routes, templates, CSS) 2. Getting Started content (3 pages) 3. Core features content (16 pages) 4. Advanced features content (14 pages) 5. Polish and review Total estimate: 24-38 hours Includes: - Complete file structure - Route implementation with navigation - CSS styling (900+ lines) - Content template examples - Screenshot guidelines - Content writing style guide - Testing checklist Co-Authored-By: Claude Sonnet 4.5 --- TODO-documentation.md | 1042 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1042 insertions(+) create mode 100644 TODO-documentation.md diff --git a/TODO-documentation.md b/TODO-documentation.md new file mode 100644 index 0000000..5dccc58 --- /dev/null +++ b/TODO-documentation.md @@ -0,0 +1,1042 @@ +# TODO: Documentation System + +**Branch:** `v20260207-02-wiki-documentation` +**Date:** 2026-02-07 +**Status:** Planning phase + +--- + +## 🎯 Goal + +Add a static documentation system to BackupChecks for user onboarding and reference. A comprehensive guide explaining how the application works, accessible only to logged-in users. + +--- + +## ✅ Requirements Summary + +- **Format:** HTML templates (for full CSS control) +- **Structure:** Multiple pages with navigation menu +- **Menu Item:** "Documentation" with 📖 icon +- **Access:** Logged-in users only +- **Content:** Basic + Advanced topics (all features) +- **Language:** English only (app is not translated to Dutch) +- **Screenshots:** Yes, embedded in pages +- **Maintenance:** Static content updated via git (no in-app editing) + +--- + +## 📋 Documentation Structure + +### Navigation Menu (Left Sidebar) + +``` +Documentation 📖 +├─ 🏠 Getting Started +│ ├─ What is BackupChecks? +│ ├─ First Login & Dashboard +│ └─ Quick Start Checklist +│ +├─ 👥 User Management +│ ├─ Users & Roles +│ ├─ Login & Authentication +│ └─ Profile Settings +│ +├─ 💼 Customers & Jobs +│ ├─ Managing Customers +│ ├─ Configuring Jobs +│ ├─ Approved Jobs +│ └─ Job Schedules +│ +├─ 📧 Mail & Import +│ ├─ Mail Import Setup +│ ├─ Inbox Management +│ ├─ Mail Parsing +│ └─ Auto-Import Configuration +│ +├─ ✅ Backup Review +│ ├─ Approving Backups +│ ├─ Daily Jobs View +│ ├─ Run Checks Modal +│ ├─ Overrides & Exceptions +│ └─ Remarks & Tickets +│ +├─ 📊 Reports +│ ├─ Creating Reports +│ ├─ Relative Periods +│ ├─ Report Scheduling +│ └─ Exporting Data +│ +├─ 🎫 Autotask Integration +│ ├─ Setup & Configuration +│ ├─ Company Mapping +│ ├─ Creating Tickets +│ └─ Ticket Management +│ +├─ ⚙️ Settings +│ ├─ General Settings +│ ├─ Mail Configuration +│ ├─ Autotask Integration +│ ├─ Reporting Settings +│ ├─ User Management +│ └─ Maintenance +│ +└─ ❓ Troubleshooting + ├─ Common Issues + ├─ FAQ + └─ Support Contact +``` + +--- + +## 🎨 UI Design + +### Layout Structure + +``` +┌─────────────────────────────────────────────────────┐ +│ Navbar (standard app navbar) │ +├──────────────┬──────────────────────────────────────┤ +│ │ │ +│ Navigation │ Content Area │ +│ Sidebar │ │ +│ (250px) │ ┌─ Breadcrumb ───────────────────┐ │ +│ │ │ Documentation > Getting Started │ │ +│ 📖 Docs │ └─────────────────────────────────┘ │ +│ │ │ +│ 🏠 Getting │

What is BackupChecks?

│ +│ Started │ │ +│ • What is │

BackupChecks is a...

│ +│ • First │ │ +│ • Quick │ │ +│ │ │ +│ 👥 Users │

Key Features

│ +│ • Users & │