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 │
BackupChecks is a...
│ +│ • First │ │ +│ • Quick │+ BackupChecks is a backup monitoring and validation system designed to help IT teams + verify that backups are running successfully across their customer infrastructure. +
+ +
+ BackupChecks follows a simple workflow:
+ +BackupChecks is designed for:
+ +BackupChecks supports parsing backup reports from:
+ +| Software | +Support Level | +Notes | +
|---|---|---|
| Veeam Backup & Replication | +Full | +Email notifications with detailed job status | +
| Acronis Cyber Protect | +Full | +Backup completion reports | +
| Synology Active Backup | +Full | +Task result notifications | +
| Custom/Other | +Configurable | +Manual job configuration for non-standard formats | +
Ready to get started? Continue to:
+ +