Organizing Content

Folder Structure Best Practices

A well-organized documentation structure improves user experience.

Recommended Hierarchy

/
├── /home (Home/Landing page)
├── /getting-started (Quick guides)
│   ├── /introduction
│   ├── /quick-start
│   └── /installation
├── /user-guide (How-to guides)
│   ├── /creating-documents
│   └── /organizing-content
├── /api (Developer documentation)
│   ├── /authentication
│   └── /rest-endpoints
├── /guidelines (Standards)
│   ├── /writing-style
│   └── /markdown-formatting
└── /faq (Frequently asked questions)

Creating Folders

1. Go to Menu Items Management
2. Click Add Folder
3. Enter folder details:
   • Name: Display name
   • Path: URL path
   • Display Order: Position
4. Click Save

Folder Naming Conventions

Do's

• Use lowercase letters and hyphens
• Use descriptive names
• Keep names concise
• Use consistent patterns
• Group related documents

Don'ts

• Don't use spaces (use hyphens)
• Don't use special characters
• Don't nest more than 3 levels deep

Best Practices

• Create a sitemap or index page
• Add breadcrumb navigation
• Cross-reference related documents
• Review content regularly
• Update version numbers
• Archive old versions