Cirth Docs

Creating Projects

Learn how to create and configure documentation projects in Cirth.

Updated 2/9/2026
Author
LicenseMIT

Projects are the foundation of your documentation in Cirth. Each project represents a separate documentation site with its own pages, versions, and settings.

Project Settings

When creating or editing a project, you can configure the following:

Basic Information

Field

Description

Example

Name

Display name shown in navigation

"Acme SDK Documentation"

Slug

URL identifier (auto-generated from name)

"acme-sdk"

Description

Brief overview for SEO and listings

"Official docs for Acme SDK"

Branding

Customize how your documentation looks:

  • Logo: Upload a logo image (recommended: 200x200px PNG)

  • Favicon: Browser tab icon (16x16 or 32x32 ICO/PNG)

  • Theme: Select a pre-built color scheme

Visibility Settings

Control who can access your documentation:

Public Access

When enabled:

  • Anyone can view your documentation

  • No login required

  • Appears in your public profile

When disabled:

  • Only you can access the documentation

  • Useful for drafts or internal docs

Search Engine Indexing

When enabled:

  • Search engines can crawl and index pages

  • Generates XML sitemap automatically

  • Proper meta tags for SEO

When disabled:

  • robots.txt blocks crawlers

  • Keeps documentation private from search results

Managing Multiple Projects

From your dashboard, you can:

  1. View all projects - See cards for each project with quick stats

  2. Search projects - Filter by name when you have many projects

  3. Sort projects - Order by name, creation date, or last updated

  4. Archive projects - Hide old projects without deleting

Project Analytics

Each project tracks:

  • Total Views: Lifetime page views across all pages

  • Popular Pages: Most visited documentation pages

  • Version Usage: Which versions readers access most

Best Practices

Naming Conventions

Choose clear, descriptive names:

  • Good: "Payment API v2 Documentation"

  • Avoid: "Docs" or "New Project"

Slug Selection

Slugs appear in URLs, so make them:

  • Short and memorable

  • Lowercase with hyphens

  • Related to your product name

      

        plaintext
        
      

    https://cirth.app/docs/payment-api    ✓ Good
https://cirth.app/docs/my-new-docs-1  ✗ Avoid

One Project Per Product

Create separate projects for:

  • Different products or services

  • Major API versions (v1 vs v2)

  • Different audiences (users vs developers)

Deleting Projects

To delete a project:

  1. Go to Project Settings

  2. Scroll to Danger Zone

  3. Click Delete Project

  4. Confirm by typing the project name

Warning: Deletion is permanent and removes all pages, versions, and history.