Quick Start Guide

This guide will help you create your first documentation site with Cirth in just a few minutes.

Prerequisites

• A Cirth account (sign up at Cirth)

• Your documentation content (or start fresh!)

Step 1: Create a Project

1. After logging in, click New Project from the dashboard

2. Fill in the project details:

   • Name: Your project's display name (e.g., "My API Docs")

   • Slug: URL-friendly identifier (e.g., "my-api-docs")

   • Description: Brief description of what the docs cover

3. Configure visibility:

   • Toggle Public to make docs accessible to everyone

   • Enable Search Indexing if you want search engines to find your docs

4. Click Create Project

Step 2: Create Your First Page

1. From your project dashboard, click New Page

2. Enter a title (this becomes your page heading)

3. Write your content using the rich text editor:

   • Use markdown shortcuts for quick formatting

   • Add code blocks with syntax highlighting

   • Insert links, images, and more

4. Set the page status to Published

5. Click Save

Step 3: Organize Your Documentation

Cirth supports hierarchical page organization:

      

        plaintext
        
          
          
        
      
    Getting Started (parent)
├── Installation (child)
├── Configuration (child)
└── First Steps (child)
API Reference (parent)
├── Authentication
└── Endpoints

To create child pages:

1. When creating a new page, select a Parent Page

2. Use the Order field to control page sequence

3. Drag and drop pages to reorder them

Step 4: Preview Your Site

1. Click View Documentation from the project dashboard

2. Your docs are now live at: cirth.app/docs/your-slug

3. Share the link with your team or users!

Next Steps

• Creating Projects - Deep dive into project settings

• Writing Pages - Master the page editor

• Custom Domains - Connect your own domain

• GitHub Import - Import existing documentation

Tips for Success

1. Start with an outline - Plan your documentation structure before writing

2. Use clear headings - Help readers navigate with descriptive titles

3. Include code examples - Developers love practical examples

4. Keep it updated - Set a schedule to review and refresh content