diff --git a/docs.json b/docs.json new file mode 100644 index 00000000..88412292 --- /dev/null +++ b/docs.json @@ -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" + } + ] + } +} diff --git a/docs/development.md b/docs/development.md index 42c7665c..0d1060d5 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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).