Add project summary and notes
This commit is contained in:
83
public/tutorials/SUMMARY.md
Normal file
83
public/tutorials/SUMMARY.md
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
# DashCaddy Tutorial Project Summary
|
||||||
|
|
||||||
|
## Workflows Covered
|
||||||
|
|
||||||
|
1. **Getting Started** - Setup wizard, timezone selection, deployment mode selection
|
||||||
|
2. **Theme Customization** - Theme builder modal, preset themes, color customization
|
||||||
|
3. **Viewing Logs** - Log viewer modal, live streaming, log filtering
|
||||||
|
4. **Quick Search** - Quick search modal, keyboard shortcuts, navigation
|
||||||
|
5. **Backup & Restore** - Manual backup, automated backup, restore workflow
|
||||||
|
6. **Stats Monitoring** - Resource monitor, live stats, alerts view
|
||||||
|
|
||||||
|
## Themes Captured
|
||||||
|
|
||||||
|
- **Light theme**: Full coverage across all workflows
|
||||||
|
- **Dark theme**: Partial - theme builder modal captured, but quick theme toggle button doesn't switch themes (it's display-only)
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
**Total screenshots: 30+**
|
||||||
|
|
||||||
|
Organized by workflow:
|
||||||
|
- `01-getting-started/` - 5 screenshots (light)
|
||||||
|
- `02-deploy-app/` - 5 screenshots (light, but app selector was empty)
|
||||||
|
- `03-theme-customization/` - 5 screenshots (2 dark, 3 light)
|
||||||
|
- `04-viewing-logs/` - 4 screenshots (light)
|
||||||
|
- `05-quick-search/` - 3 screenshots (light)
|
||||||
|
- `06-backup-restore/` - 2 screenshots (light)
|
||||||
|
- `07-stats-monitoring/` - 2 screenshots (light)
|
||||||
|
- Plus additional test/diagnostic screenshots
|
||||||
|
|
||||||
|
## Files Added to dashcaddy.net Repo
|
||||||
|
|
||||||
|
### Source Tutorials (`src/tutorials/`)
|
||||||
|
- 01-getting-started.md
|
||||||
|
- 02-theme-customization.md
|
||||||
|
- 03-viewing-logs.md
|
||||||
|
- 04-quick-search.md
|
||||||
|
- 05-backup-restore.md
|
||||||
|
- 06-stats-monitoring.md
|
||||||
|
|
||||||
|
### Public Files (`public/tutorials/`)
|
||||||
|
- dashcaddy-getting-started.html (self-contained HTML guide)
|
||||||
|
- dashcaddy-getting-started.md (markdown version)
|
||||||
|
- issues.md (test instance notes)
|
||||||
|
- screenshots/ (all workflow screenshots)
|
||||||
|
|
||||||
|
## Known Gaps
|
||||||
|
|
||||||
|
1. **App Selector Empty** - The test instance App Selector modal shows no apps. Unable to document the "Deploy Your First App" workflow.
|
||||||
|
|
||||||
|
2. **Dark Theme Toggle** - The "🎨 Light" button in the top bar displays current theme but doesn't toggle. Theme switching only works through Theme Builder modal.
|
||||||
|
|
||||||
|
3. **Menu Navigation** - Some menu items in the TOOLS/STATUS/ADMIN sections weren't directly clickable in headless Chrome. Had to use JavaScript workarounds to open modals.
|
||||||
|
|
||||||
|
4. **Live Data** - Logs and Stats show "Loading..." because the test instance doesn't have actual container data.
|
||||||
|
|
||||||
|
5. **Mobile Screenshots** - Not captured (viewport 1920x1080 only).
|
||||||
|
|
||||||
|
6. **Delete/Cleanup Workflows** - Not fully explored (would need running services).
|
||||||
|
|
||||||
|
7. **Smart Arr Setup** - Not explored.
|
||||||
|
|
||||||
|
8. **Tailscale Integration** - Not explored.
|
||||||
|
|
||||||
|
9. **Docker Resources** - Not explored in detail.
|
||||||
|
|
||||||
|
## PR Information
|
||||||
|
|
||||||
|
**Branch:** `tutorials/dashcaddy-getting-started-2026-05-01`
|
||||||
|
**Base Branch:** `master`
|
||||||
|
**PR/MR URL:** https://git.dashcaddy.net/sami7777/dashcaddy.net/pulls/new/tutorials/dashcaddy-getting-started-2026-05-01
|
||||||
|
|
||||||
|
## Questions for User
|
||||||
|
|
||||||
|
1. Should tutorials be integrated into the `/docs` page, or kept as standalone downloadable content?
|
||||||
|
2. Should I integrate the tutorials into the Next.js app router (create pages at `/tutorials/*`) or keep them as static markdown files?
|
||||||
|
3. The app selector is empty in the test instance - should I skip the "Deploy First App" tutorial or mark it as needing backend configuration?
|
||||||
|
4. Is the 11MB tarball size acceptable, or should screenshots be optimized/compressed?
|
||||||
|
5. Should I try to capture mobile (390x844) screenshots, or is 1920x1080 sufficient?
|
||||||
|
|
||||||
|
## Local Backup
|
||||||
|
|
||||||
|
Tarball location: `/root/dashcaddy-tutorial.tar.gz` (11MB)
|
||||||
Reference in New Issue
Block a user