79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
# Help & Documentation Page Recommendation
|
|
|
|
## Decision: **ONE COMBINED PAGE**
|
|
|
|
### Analysis
|
|
|
|
**Current Structure:**
|
|
- `/help` - Help & Support (placeholder)
|
|
- `/help/docs` - Documentation (placeholder)
|
|
- Both shown as separate menu items in sidebar
|
|
|
|
**Documentation Available:**
|
|
- `/docs` folder with comprehensive technical documentation
|
|
- 6 main documentation files covering architecture, frontend, backend, AI functions
|
|
- Well-organized markdown structure
|
|
|
|
**Recommendation: Single Combined Page**
|
|
|
|
### Reasons:
|
|
|
|
1. **User Experience**
|
|
- Users don't need to decide between "Help" and "Documentation"
|
|
- All information in one place
|
|
- Better discoverability
|
|
|
|
2. **Content Overlap**
|
|
- Help content often references documentation
|
|
- Documentation includes help content
|
|
- No clear boundary between the two
|
|
|
|
3. **Modern Pattern**
|
|
- Most modern apps combine them (GitHub, Stripe, Vercel, etc.)
|
|
- Single entry point is cleaner
|
|
- Better for SEO and navigation
|
|
|
|
4. **WordPress Plugin Pattern**
|
|
- Uses subpages (`?sp=help`, `?sp=docs`)
|
|
- Suggests they're meant to be together
|
|
- Can maintain consistency
|
|
|
|
5. **Content Size**
|
|
- Documentation isn't so large it needs separation
|
|
- Can be organized with tabs/sections
|
|
|
|
### Proposed Structure:
|
|
|
|
**Single `/help` page with sections:**
|
|
|
|
1. **Getting Started** (Tab/Section)
|
|
- Quick start guide
|
|
- Common workflows
|
|
- Video tutorials
|
|
- Setup instructions
|
|
|
|
2. **Documentation** (Tab/Section)
|
|
- Architecture & Tech Stack
|
|
- Frontend Documentation
|
|
- Backend Documentation
|
|
- AI Functions
|
|
- API Reference
|
|
|
|
3. **FAQ & Troubleshooting** (Tab/Section)
|
|
- Common questions
|
|
- Troubleshooting guides
|
|
- Known issues
|
|
|
|
4. **Support** (Tab/Section)
|
|
- Contact support
|
|
- Community resources
|
|
- Feature requests
|
|
|
|
### Implementation:
|
|
|
|
- Use tabs or sidebar navigation within the page
|
|
- Smooth transitions between sections
|
|
- Search functionality across all content
|
|
- Mobile-responsive design
|
|
|