Implementation:Mage ai Mage ai Docs Site Configuration
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Configuration |
| Last Updated | 2026-02-09 00:00 GMT |
Overview
Configuration file defining the structure and navigation of the Mage AI documentation site.
Description
The docs.json file defines the complete documentation site navigation tree for Mage AI. It is a Mintlify-based configuration file (identified by the $schema pointing to https://mintlify.com/docs.json) that specifies page groupings, ordering, and hierarchy for the documentation website. The file uses the "maple" theme and configures the primary brand colors (#6A35FF, #00FB82, #148EFF) along with a favicon reference.
The navigation structure is organized into top-level tabs, each containing groups of pages. Major tabs include:
- Mage Pro -- covering deployment architecture (SaaS, hybrid cloud, private cloud, on-prem), getting started guides, CI/CD workflows, and Pro-only features such as AI (Sidekick, RAG pipelines), dynamic blocks, streaming, data integrations (sources and destinations), and developer experience tools.
- Additional groups cover Infrastructure (Compute with Spark and Databricks, Storage with Iceberg), and many other documentation sections spanning pipelines, blocks, triggers, integrations, and contributing guides.
Each group entry can contain a flat list of page paths or nested sub-groups with optional icons (e.g., microchip-ai, block-brick, stream, link, terminal, stars, database). The file totals 1398 lines.
Usage
This configuration is consumed by the Mintlify documentation site generator to build the navigation sidebar and page structure. Modify this file to add, remove, or reorganize documentation pages. Changes to this file are reflected in the rendered documentation site at https://docs.mage.ai.
Code Reference
Source Location
- Repository: mage-ai
- File: docs/docs.json
- Lines: 1-1398
Signature
{
"$schema": "https://mintlify.com/docs.json",
"theme": "maple",
"name": "Mage AI",
"colors": {
"primary": "#6A35FF",
"light": "#00FB82",
"dark": "#148EFF"
},
"favicon": "/favicons/m1.svg",
"navigation": {
"tabs": [
{
"tab": "Mage Pro",
"groups": [
{
"group": "Adventure starts here",
"pages": ["production/mage/pro"]
},
{
"group": "Deployment architecture",
"pages": [
"pro-architecture/architecture-overview",
"pro-architecture/saas",
"pro-architecture/hybrid-cloud",
"pro-architecture/private-cloud",
"pro-architecture/on-prem"
]
}
// ... additional groups and tabs
]
}
]
}
}
Import
# Configuration file - not imported directly
# Used by the Mintlify documentation site builder
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| (none) | JSON file | Yes | Read by the Mintlify documentation site builder at build time |
Outputs
| Name | Type | Description |
|---|---|---|
| navigation_tree | JSON | Hierarchical documentation site structure including tabs, groups, and page paths |
Usage Examples
import json
with open("docs/docs.json") as f:
docs_config = json.load(f)
# Access the site name and theme
print(docs_config["name"]) # "Mage AI"
print(docs_config["theme"]) # "maple"
# Iterate through navigation tabs
for tab in docs_config["navigation"]["tabs"]:
print(f"Tab: {tab['tab']}")
for group in tab["groups"]:
print(f" Group: {group['group']} ({len(group['pages'])} pages)")