Search Documentation

Search for pages and headings in the documentation

Hierarchical Navigation Power

CelestialDocs’ three-tier hierarchy (Entries -> Groups -> Tabs) is specifically designed to scale documentation from tiny to enterprise-scale without requiring deep nesting or complexity.

The Hierarchy Advantage

Tier 1: Entries (Pages)

Individual files, clickable links

Tier 2: Groups (Collections)

Organize related entries into sidebar sections

Tier 3: Tabs (Contexts)

Switch between major documentation sections

Why three tiers?

  • One tier (flat): Okay for 10 pages, chaos for 100
  • Two tiers: Good for 50-200 pages, gets convoluted
  • Three tiers: Perfect for 100-10,000 pages
  • Four+ tiers: Causes navigation fatigue

Real-World Scaling

Small Project (10-50 pages)

[Learn]
β”œβ”€β”€ Getting Started
β”‚   β”œβ”€β”€ Intro
β”‚   └── Install
β”œβ”€β”€ Features
└── Help

Configuration: 3-4 groups, auto-generated Complexity: Trivial

Medium Project (50-200 pages)

[Learn] [API] [Patterns]
β”œβ”€β”€ Getting Started
β”œβ”€β”€ Guides
β”‚   β”œβ”€β”€ Authentication
β”‚   β”œβ”€β”€ Deployment
β”‚   └── Testing
β”œβ”€β”€ Advanced
    └── (auto-gen)

Configuration: Multiple groups, some nesting Complexity: Moderate

Large Project (200-1000 pages)

[Getting Started] [User Docs] [API Reference] [Patterns]
β”œβ”€β”€ Learn
β”œβ”€β”€ Configuration
β”‚   β”œβ”€β”€ Basics
β”‚   β”œβ”€β”€ Advanced
β”‚   β”‚   β”œβ”€β”€ Caching
β”‚   β”‚   β”œβ”€β”€ Performance
β”‚   β”‚   └── Security
β”‚   └── Deployment
└── Reference

Configuration: Deep nesting, multiple tabs Complexity: Managed

Enterprise (1000+ pages)

[Docs] [API v1] [API v2] [API v3] [SDKs] [Community] [Help]
β”œβ”€β”€ User Guide
β”œβ”€β”€ Admin Guide
β”‚   β”œβ”€β”€ Configuration
β”‚   β”‚   β”œβ”€β”€ Basics
β”‚   β”‚   β”œβ”€β”€ Advanced
β”‚   β”‚   └── Automation
β”‚   β”œβ”€β”€ Deployment
β”‚   β”œβ”€β”€ Security
β”‚   └── Monitoring
β”œβ”€β”€ Integration Guide
└── Reference

Configuration: Complex nesting, many tabs Complexity: High but manageable

Why This Scales

1. Logical Organization

Content organized by meaning, not arbitrary depth

2. Flexible Nesting

Can nest 2-3 levels for organization without UI clutter

3. Tab Separation

Tabs act as β€œreset buttons” - switch contexts completely

4. Auto-Generation at Any Level

Auto-discovery works at every nesting level

5. Type Safety

All configuration is TypeScript - errors caught early

Comparison: Other Systems

MkDocs (File-based)

docs/
β”œβ”€β”€ index.md
β”œβ”€β”€ guide/
β”‚   β”œβ”€β”€ index.md
β”‚   β”œβ”€β”€ installation.md
β”‚   └── quickstart.md
β”œβ”€β”€ api/
β”‚   β”œβ”€β”€ index.md
β”‚   └── reference.md

Problem: Navigation structure locked to file system Solution: Manual YAML config that duplicates structure

Docusaurus (Sidebar file)

sidebar:
    - label: "Getting Started"
      items:
          - id: "getting-started/index"
          - label: "Installation"
            id: "getting-started/installation"

Problem: Manual config grows unwieldy (1000+ lines) Solution: None - config scales with documentation

CelestialDocs (Smart hierarchy)

{
    id: "getting-started",
    label: "Getting Started",
    autoGenerated: true,
}

Benefit: Config is compact, auto-discovers as docs grow Scales: Configuration stays manageable at 1000+ pages

Concrete Benefits

For Documentation Maintainers

βœ… Clarity

Clear structure: Docs -> Guides -> Advanced Topics -> Troubleshooting
vs.
"Where does this page go?"

βœ… Maintainability

One group grows? Fine, it auto-discovers
New tab needed? Add one tab, not restructure everything

βœ… Flexibility

Can promote subgroup to tab without refactoring
Can nest groups for organization without clutter

For Documentation Readers

βœ… Intuitive Navigation

Users understand the structure at a glance
Tabs separate concerns (guides vs. API)
Groups organize related content

βœ… Never Lost

Breadcrumbs show: Home > Guides > Advanced > Performance
Users always know where they are

βœ… Discoverable

All content findable through navigation
No "hidden" corners of documentation

For Teams

βœ… Grow Without Refactoring

Month 1: 5 groups
Month 6: 5 groups (more entries in each)
Month 12: Add 2 tabs, still same structure

βœ… Coordinate Easier

Teams work on different tabs independently
No merge conflicts from reordering

βœ… Onboard Faster

New team member: "Just add markdown files"
No need to understand complex hierarchy

Example: This Documentation

This site demonstrates the power:

[Overview]
[Getting Started] - Sequential learning
[Navigation System] - Core concepts with 2-level nesting
[Configuration] - Advanced 3-level hierarchy
[Generation Strategies] - Three different approaches
[Content] - Markdown + frontmatter
[Advanced Topics] - Multiple selling points

Structure:

  • 7 top-level tabs
  • Some with nested groups
  • Some auto-generated sections
  • Mix of manual and automatic

Scales: Add a new tab, everything works Maintains: Config file still manageable Grows: New pages auto-discovered automatically

Selling Points

  1. Starts Simple, Scales Complex β€œWorks perfectly whether you have 10 pages or 10,000”

  2. No Reorg as You Grow β€œAdd tabs and groups, never restructure existing navigation”

  3. Flexible Nesting β€œ2-3 levels for organization, unlimited scalability”

  4. User-Friendly β€œBreadcrumbs and clear hierarchy mean users never get lost”

  5. Type-Safe β€œConfiguration errors caught at development time”


Next: Learn other selling points: