Keel Docs
Contributing

Adding Documentation

How to add and organize documentation pages.

Adding Documentation

Docs pages are MDX files in content/docs/. The sidebar navigation is controlled by meta.json files.

File Structure

content/docs/
├── index.mdx              # Docs landing page (/docs)
├── meta.json              # Root sidebar structure
├── getting-started/
│   ├── index.mdx          # Section landing (/docs/getting-started)
│   ├── first-backtest.mdx # Tutorial page
│   └── meta.json          # Section sidebar ordering
├── api-reference/
│   ├── index.mdx
│   └── meta.json
└── contributing/
    ├── adding-blog-posts.mdx
    ├── adding-docs.mdx
    └── meta.json

Page Frontmatter

---
title: "Page Title"
description: "Brief description for SEO."
---

Each directory can have a meta.json to control sidebar ordering:

{
  "title": "Getting Started",
  "pages": ["index", "first-backtest", "deploying"]
}

Separators

Add group headers in the root meta.json:

{
  "pages": [
    "---Getting Started---",
    "getting-started",
    "---API---",
    "api-reference"
  ]
}

Adding a New Section

  1. Create a directory under content/docs/
  2. Add an index.mdx with the section overview
  3. Add a meta.json with page ordering
  4. Add the section to the root meta.json

Cross-Linking

Link to other docs pages with relative paths:

See the [Getting Started guide](/docs/getting-started) for setup instructions.

Table of Contents

TOC is automatically generated from headings (H2 and H3) in each page.

Full-text search is built-in via Fumadocs/Orama. All docs content is automatically indexed — no configuration needed.

On this page

Adding DocumentationFile StructurePage FrontmatterSidebar Navigation (meta.json)SeparatorsAdding a New SectionCross-LinkingTable of ContentsSearch