Implementation:Openclaw Openclaw Docs Navigation Config
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Configuration, Navigation |
| Last Updated | 2026-02-06 12:00 GMT |
Overview
Mintlify documentation site configuration that defines the complete navigation structure, theming, redirects, and sidebar organization for the OpenClaw docs at docs.openclaw.ai.
Description
The docs.json file is the master configuration for the Mintlify-hosted documentation site. It defines the site theme (colors, fonts, logo, favicon), navbar links (GitHub, Releases), URL redirects for legacy paths, API reference settings, language/i18n tabs, footer links, and the full sidebar navigation tree organized into tabbed sections (Getting Started, Gateway, CLI, Channels, Tools, Concepts, Reference).
At 1736 lines, this is a large declarative JSON configuration that controls the entire documentation site structure. Changes to this file affect documentation navigation, page discoverability, and URL routing.
Usage
This configuration is consumed by the Mintlify build system. Edit this file when adding new documentation pages, reorganizing navigation, adding redirects, or updating site-wide theming. The file is validated against the Mintlify JSON schema (`https://mintlify.com/docs.json`).
Code Reference
Source Location
- Repository: Openclaw_Openclaw
- File: docs/docs.json
- Lines: 1-1736
Signature
{
"$schema": "https://mintlify.com/docs.json",
"name": "OpenClaw",
"theme": "mint",
"icons": { "library": "lucide" },
"logo": { "light": "/assets/pixel-lobster.svg", "dark": "/assets/pixel-lobster.svg" },
"fonts": {
"body": { "family": "Fragment Mono" },
"heading": { "family": "DM Sans" }
},
"favicon": "/assets/pixel-lobster.svg",
"colors": { "primary": "#FF5A36", "dark": "#FF5A36", "light": "#FF8A6B" },
"navbar": { "links": [ /* GitHub, Releases */ ] },
"redirects": [ /* legacy URL redirects */ ],
"api": { /* API reference configuration */ },
"tabs": [ /* Getting Started, Gateway, CLI, Channels, Tools, Concepts, Reference */ ],
"navigation": [ /* full sidebar tree */ ],
"footer": { /* social links */ }
}
Import
# Not imported in code; consumed by Mintlify build:
# mintlify dev (local preview)
# mintlify build (production build)
# The file must be at docs/docs.json (or mint.json) in the repository root.
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| $schema | string | No | Mintlify JSON schema URL for validation |
| name | string | Yes | Site name displayed in header |
| theme | string | Yes | Mintlify theme name ("mint") |
| colors | object | Yes | Primary, dark, and light accent colors |
| tabs | array | Yes | Top-level navigation tabs |
| navigation | array | Yes | Sidebar navigation groups with page paths |
| redirects | array | No | URL redirect rules for legacy paths |
Outputs
| Name | Type | Description |
|---|---|---|
| Documentation site | HTML | Rendered documentation at docs.openclaw.ai |
| Navigation sidebar | UI | Hierarchical page navigation |
| URL redirects | HTTP 301/302 | Legacy URL redirects to new locations |
Usage Examples
Adding a New Documentation Page
// To add a new page "docs/channels/newchannel.md":
// 1. Create the markdown file at docs/channels/newchannel.md
// 2. Add it to the appropriate navigation group in docs.json:
{
"group": "Channels",
"pages": [
"channels/index",
"channels/telegram",
"channels/discord",
"channels/newchannel"
]
}
Adding a URL Redirect
// To redirect /oldpath to /newpath:
{
"redirects": [
{
"source": "/oldpath",
"destination": "/newpath"
}
]
}