ivooskamp/backupchecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add comprehensive TODO for documentation system

Browse Source 
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 <noreply@anthropic.com>
This commit is contained in:
Ivo Oskamp 2026-02-07 23:47:33 +01:00
parent 8ebfb9e90f
commit 73b1f25279
1 changed files with 1042 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1042
TODO-documentation.md Normal file
View File

File diff suppressed because it is too large Load Diff