Skip to content
Knode Docs

Create Documentation

Create Documentation

Section titled “Create Documentation”

This guide explains how to add or update pages in the Knode docs site.

1. Choose a page path

Section titled “1. Choose a page path”

All docs live under src/content/docs/. Use descriptive, lowercase paths with hyphens.

Examples:

  • product/onboarding.mdx
  • reference/faq.mdx

2. Add frontmatter

Section titled “2. Add frontmatter”

Every page needs a title and optional description:

---
title: My Page Title
description: Optional summary for search and previews.
---

3. Write the content

Section titled “3. Write the content”

Use Markdown or MDX. Keep sections scannable and focused on the user task.

# Heading


Short intro paragraph.


## Step-by-step


1. Do this.
2. Do that.

4. Preview locally

Section titled “4. Preview locally”

From the repo root:

Terminal window
npm install
npm run dev --workspace knode-docs

Navigate to http://localhost:3006/ to preview your changes.

5. Publish with Ops Dashboard

Section titled “5. Publish with Ops Dashboard”
  1. Open the Docs page in the Ops Dashboard.
  2. Select or create a page.
  3. Save changes, then click Publish.
  4. Verify the public page in the preview panel.

6. Keep navigation updated

Section titled “6. Keep navigation updated”

If you add a major section, update frontends/apps/knode-docs/astro.config.mjs to add the page to the sidebar.