1.9 KiB
1.9 KiB
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:
/docsfolder with comprehensive technical documentation- 6 main documentation files covering architecture, frontend, backend, AI functions
- Well-organized markdown structure
Recommendation: Single Combined Page
Reasons:
-
User Experience
- Users don't need to decide between "Help" and "Documentation"
- All information in one place
- Better discoverability
-
Content Overlap
- Help content often references documentation
- Documentation includes help content
- No clear boundary between the two
-
Modern Pattern
- Most modern apps combine them (GitHub, Stripe, Vercel, etc.)
- Single entry point is cleaner
- Better for SEO and navigation
-
WordPress Plugin Pattern
- Uses subpages (
?sp=help,?sp=docs) - Suggests they're meant to be together
- Can maintain consistency
- Uses subpages (
-
Content Size
- Documentation isn't so large it needs separation
- Can be organized with tabs/sections
Proposed Structure:
Single /help page with sections:
-
Getting Started (Tab/Section)
- Quick start guide
- Common workflows
- Video tutorials
- Setup instructions
-
Documentation (Tab/Section)
- Architecture & Tech Stack
- Frontend Documentation
- Backend Documentation
- AI Functions
- API Reference
-
FAQ & Troubleshooting (Tab/Section)
- Common questions
- Troubleshooting guides
- Known issues
-
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