Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "OpenAgentCore",
"colors": {
"primary": "#2563EB"
},
"favicon": "/docs/assets/openagentcore-logo.svg",
"navigation": {
"groups": [
{
"group": "Get started",
"pages": [
"docs/getting-started/README",
"docs/getting-started/install",
"docs/getting-started/quickstart",
"docs/examples"
]
},
{
"group": "Operate",
"pages": [
"docs/getting-started/install-options",
"docs/getting-started/nodes",
"docs/getting-started/self-hosted",
"docs/getting-started/operations",
"docs/configuration"
]
},
{
"group": "API guides",
"pages": [
"docs/api/README",
"docs/api/public-agent-api",
"contracts/agents-api/admin-api",
"contracts/agents-api/machine-api",
"contracts/agents-api/harness-capabilities"
]
},
{
"group": "Architecture and extensions",
"pages": [
"docs/concepts",
"docs/architecture",
"docs/runtime-protocol",
"docs/runtime-bootstrap",
"docs/sandbox-provider",
"contracts/agents-api/harness-onboarding",
"docs/development",
"CONTRIBUTING"
]
}
]
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/MiniMax-AI/OpenAgentCore"
}
]
}
}
2 changes: 2 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ Fixture browser acceptance uses loopback ports 18092 and 4174. Select unused por

## Change documentation

The repository-root `docs.json` configures the Mintlify site and references the existing Markdown sources. Connect Mintlify to the repository root on the default branch. Run `mint dev` from the repository root to preview the site and `mint validate` to check it before publishing. Install the CLI with `npm install -g mint`.

Find the owning source in the [documentation ownership map](../CONTRIBUTING.md#documentation-ownership) and follow the [documentation rules](../AGENTS.md#documentation). Readers use the authored Markdown in the repository. Generated OpenAPI schemas and the Harness catalog have their own generators; see [Contract and schema rules](../CONTRIBUTING.md#contract-and-schema-rules).

The distribution has an explicit documentation list in `scripts/core-distribution-manifest.py`. When you move a bundled file or change a heading, update its inbound links and run the [distribution documentation checks](maintainers.md#build-a-distribution).
Loading