Creating Documentation Sites

Learn how to build a documentation site with sidebar navigation using Cravo.


Overview

Cravo is perfect for creating documentation sites, knowledge bases, and help centers. The Docs template provides:

  • Sidebar navigation for easy browsing
  • Hierarchical structure for organized content
  • Breadcrumbs for location awareness
  • Fast, searchable content

Choosing a Docs Template

When creating a new site:

  1. Click Create New Site in your dashboard
  2. Select Start with a Template
  3. Choose the Documentation template
  4. Connect your Craft document

📸 PLACEHOLDER: Screenshot
Template selection showing the Documentation template.


Documentation Structure

Organize your Craft document for optimal documentation:

text
1Docs (Root)
2├── Getting Started
3│ ├── Installation
4│ ├── Quick Start
5│ └── Configuration
6├── Guides
7│ ├── Basic Usage
8│ └── Advanced Topics
9└── API Reference
10 ├── Authentication
11 └── Endpoints

Structure Best Practices

  1. Top-level = Sections – Major categories
  2. Second-level = Topics – Individual articles
  3. Third-level = Details – Sub-articles if needed

Enabling Side Menu

For documentation sites, enable the Side Menu:

  1. Go to Content → Menus
  2. Enable Side Menu
  3. Configure sidebar settings
  4. Save changes

The sidebar automatically generates from your page hierarchy.

📸 PLACEHOLDER: Screenshot
A docs site showing the sidebar with expandable sections.


Recommended Settings

For the best documentation experience:

SettingRecommendation
Top Menu✅ ON – For main sections
Side Menu✅ ON – For navigation
Breadcrumbs✅ ON – For location
Wide View❌ OFF – Better readability

Writing Good Documentation

  1. Clear headings – Use consistent heading levels (H2, H3)
  2. Code blocks – Use fenced code blocks for examples
  3. Callouts – Use Craft callouts for tips and warnings
  4. Short paragraphs – Easy to scan
  5. Visual aids – Include screenshots and diagrams

What's Next?


Need help? Contact us at support@cravo.life