Overview
Mintlify documentation site navigation configuration file that defines the complete structure, theming, navigation, and metadata for the CrewAI documentation site.
Description
This JSON configuration file conforms to the Mintlify docs.json schema and serves as the single source of truth for the CrewAI documentation site's information architecture. It controls:
- Theme and branding: Uses the "aspen" theme with CrewAI brand colors (primary #EB6658, light #F3A78B, dark #C94C3C), the Inter font family, and a grid background decoration.
- Contextual options: Configures integrations with copy, view, ChatGPT, Claude, Perplexity, MCP, Cursor, and VS Code, plus a link to request features on GitHub.
- Multi-language navigation: Defines navigation structures for three languages: English ("en"), Brazilian Portuguese ("pt-BR"), and Korean ("ko").
- Tab-based layout: Each language has tabs for Home, Documentation, AMP (Enterprise), API Reference, Examples, and Changelog.
- Documentation groups: The Documentation tab organizes content into Get Started, Guides (Strategy, Agents, Crews, Flows, Advanced), Core Concepts, MCP Integration, Tools (File & Document, Web Scraping, Search & Research, Database & Data, AI & ML, Cloud & Storage, Integrations, Automation), Observability, Learn, and Telemetry.
- Enterprise (AMP) groups: Getting Started, Build, Operate, Manage, Integration Docs (26 integrations), Triggers, How-To Guides, and Resources.
- API configuration: Bearer token authentication with simple playground mode.
- SEO and redirects: Comprehensive SEO metatags, social links in the footer, and URL redirects from legacy paths to language-prefixed paths.
Usage
This file is used by the Mintlify documentation build system to generate the navigation sidebar, tab structure, and all routing for docs.crewai.com. Any changes to documentation structure, page additions or removals, navigation ordering, or site configuration must be made through this file.
Code Reference
Source Location
- Repository: CrewAI
- File: docs/docs.json
- Lines: 1-1574
Structure
{
"$schema": "https://mintlify.com/docs.json",
"theme": "aspen",
"name": "CrewAI",
"colors": { "primary": "#EB6658", "light": "#F3A78B", "dark": "#C94C3C" },
"navigation": {
"languages": [
{ "language": "en", "tabs": [ ... ] },
{ "language": "pt-BR", "tabs": [ ... ] },
{ "language": "ko", "tabs": [ ... ] }
]
},
"api": { "baseUrl": "https://your-actual-crew-name.crewai.com", "auth": { "method": "bearer" } },
"redirects": [ ... ],
"footer": { "socials": { ... } }
}
I/O Contract
Inputs
| Name |
Type |
Required |
Description
|
| $schema |
string |
Yes |
Mintlify schema URL for validation
|
| theme |
string |
Yes |
Documentation site theme name ("aspen")
|
| name |
string |
Yes |
Site name displayed in documentation header
|
| colors |
object |
Yes |
Primary, light, and dark brand colors
|
| navigation |
object |
Yes |
Complete multi-language navigation structure with tabs and groups
|
| api |
object |
No |
API playground configuration with baseUrl and auth method
|
| redirects |
array |
No |
URL redirect rules from old paths to new paths
|
Outputs
| Name |
Type |
Description
|
| Generated site |
HTML |
Mintlify renders this config into a complete documentation website
|
Key Sections
Navigation Languages
| Language |
Code |
Tabs
|
| English |
en |
Home, Documentation, AMP, API Reference, Examples, Changelog
|
| Portuguese (BR) |
pt-BR |
Inicio, Documentacao, AMP, Referencia da API, Exemplos, Notas de Versao
|
| Korean |
ko |
Home, Documentation, Enterprise, API Reference, Examples, Changelog
|
Global Anchors
Usage Examples
Adding a New Documentation Page
{
"group": "Core Concepts",
"pages": [
"en/concepts/agents",
"en/concepts/tasks",
"en/concepts/new-concept-page"
]
}
Adding a New Redirect
{
"source": "/old-path/:path*",
"destination": "/en/new-path/:path*"
}
Related Pages
Page Connections
Double-click a node to navigate. Hold to expand connections.