Overview

Adding Documentation

Add or update Domain Manager guides in the documentation app.

The documentation site lives in apps/docs. Its Markdown pages are grouped by topic under content/.

Add a page

  1. Choose the relevant topic folder under content/, or create a new numbered folder for a new topic.
  2. Add a numbered Markdown file, for example content/1.getting-started/4.adding-documentation.md. Numbered names control the order in navigation; the filename after the number becomes the page route.
  3. Add frontmatter with a title and description. You can set a navigation icon or title there as well:
    ---
    title: Adding Documentation
    description: Add a guide to the Domain Manager docs site.
    navigation:
      icon: i-lucide-file-plus
    ---
    
  4. Write the guide in Markdown, keeping it focused on Domain Manager applications, packages, or their usage.
  5. From the repository root, run the docs app and check the page and navigation:
    pnpm --filter @domain-manager/docs dev
    

For a new section, add a .navigation.yml file in its folder to set the section title or icon. See the existing content/2.domains/ and content/3.registrars/ sections for examples.

Copyright © 2026