Skip to content

chore(website): remove unused Mintlify configuration #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RyanLee-Dev merged 2 commits into from
Oct 1, 2026
+5 −235
Merged

chore(website): remove unused Mintlify configuration #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a86d5b
chore(website): remove unused Mintlify configuration
RyanLee-Dev Oct 1, 2026
4149179
Merge main and resolve CI test conflict
RyanLee-Dev Oct 1, 2026
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
17 changes: 0 additions & 17 deletions .mintignore
View file
Open in desktop

This file was deleted.

215 changes: 0 additions & 215 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "almond",
"name": "OpenAgentCore",
"colors": {
"primary": "#15803D",
"light": "#4ADE80",
"dark": "#166534"
},
"favicon": "/docs/assets/openagentcore-logo.svg",
"navigation": {
"groups": [
{
Expand Down Expand Up @@ -53,32 +44,6 @@
}
]
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/MiniMax-AI/OpenAgentCore"
}
]
},
"appearance": {
"default": "dark",
"strict": false
},
"background": {
"color": {
"light": "#FAFAF9",
"dark": "#0C1010"
}
},
"fonts": {
"body": {
"family": "Inter"
},
"heading": {
"family": "IBM Plex Mono"
}
},
"redirects": [
{
"source": "/docs/getting-started/README",
Expand All @@ -95,186 +60,6 @@
{
"source": "/contracts/agents-api/README",
"destination": "/contracts/agents-api/index"
},
{
"source": "/docs/api/index.md",
"destination": "/docs/api/index"
},
{
"source": "/docs/api/public-agent-api.md",
"destination": "/docs/api/public-agent-api"
},
{
"source": "/docs/architecture.md",
"destination": "/docs/architecture"
},
{
"source": "/docs/concepts.md",
"destination": "/docs/concepts"
},
{
"source": "/docs/configuration.md",
"destination": "/docs/configuration"
},
{
"source": "/docs/development.md",
"destination": "/docs/development"
},
{
"source": "/docs/examples.md",
"destination": "/docs/examples"
},
{
"source": "/docs/getting-started/index.md",
"destination": "/docs/getting-started/index"
},
{
"source": "/docs/getting-started/install-options.md",
"destination": "/docs/getting-started/install-options"
},
{
"source": "/docs/getting-started/install.md",
"destination": "/docs/getting-started/install"
},
{
"source": "/docs/getting-started/nodes.md",
"destination": "/docs/getting-started/nodes"
},
{
"source": "/docs/getting-started/operations.md",
"destination": "/docs/getting-started/operations"
},
{
"source": "/docs/getting-started/quickstart.md",
"destination": "/docs/getting-started/quickstart"
},
{
"source": "/docs/getting-started/self-hosted.md",
"destination": "/docs/getting-started/self-hosted"
},
{
"source": "/docs/maintainers.md",
"destination": "/docs/maintainers"
},
{
"source": "/docs/runtime-bootstrap.md",
"destination": "/docs/runtime-bootstrap"
},
{
"source": "/docs/runtime-protocol.md",
"destination": "/docs/runtime-protocol"
},
{
"source": "/docs/sandbox-provider.md",
"destination": "/docs/sandbox-provider"
},
{
"source": "/docs/web/console-api-usage.md",
"destination": "/docs/web/console-api-usage"
},
{
"source": "/docs/web/console-server.md",
"destination": "/docs/web/console-server"
},
{
"source": "/docs/web/index.md",
"destination": "/docs/web/index"
},
{
"source": "/contracts/agents-api/admin-api.md",
"destination": "/contracts/agents-api/admin-api"
},
{
"source": "/contracts/agents-api/core-errors.md",
"destination": "/contracts/agents-api/core-errors"
},
{
"source": "/contracts/agents-api/core-metrics.md",
"destination": "/contracts/agents-api/core-metrics"
},
{
"source": "/contracts/agents-api/environment-executor-credentials.md",
"destination": "/contracts/agents-api/environment-executor-credentials"
},
{
"source": "/contracts/agents-api/environment-files.md",
"destination": "/contracts/agents-api/environment-files"
},
{
"source": "/contracts/agents-api/environments.md",
"destination": "/contracts/agents-api/environments"
},
{
"source": "/contracts/agents-api/execution-tools.md",
"destination": "/contracts/agents-api/execution-tools"
},
{
"source": "/contracts/agents-api/harness-capabilities.md",
"destination": "/contracts/agents-api/harness-capabilities"
},
{
"source": "/contracts/agents-api/harness-catalog.md",
"destination": "/contracts/agents-api/harness-catalog"
},
{
"source": "/contracts/agents-api/harness-onboarding.md",
"destination": "/contracts/agents-api/harness-onboarding"
},
{
"source": "/contracts/agents-api/index.md",
"destination": "/contracts/agents-api/index"
},
{
"source": "/contracts/agents-api/machine-api.md",
"destination": "/contracts/agents-api/machine-api"
},
{
"source": "/contracts/agents-api/message-content.md",
"destination": "/contracts/agents-api/message-content"
},
{
"source": "/contracts/agents-api/model-execution.md",
"destination": "/contracts/agents-api/model-execution"
},
{
"source": "/contracts/agents-api/node-generation-protocol.md",
"destination": "/contracts/agents-api/node-generation-protocol"
},
{
"source": "/contracts/agents-api/runtime-observability-api.md",
"destination": "/contracts/agents-api/runtime-observability-api"
},
{
"source": "/contracts/agents-api/runtime-observability.md",
"destination": "/contracts/agents-api/runtime-observability"
},
{
"source": "/contracts/agents-api/sandbox-deployment.md",
"destination": "/contracts/agents-api/sandbox-deployment"
},
{
"source": "/contracts/agents-api/session-diagnostics.md",
"destination": "/contracts/agents-api/session-diagnostics"
},
{
"source": "/contracts/agents-api/sessions-events.md",
"destination": "/contracts/agents-api/sessions-events"
},
{
"source": "/contracts/agents-api/source-files.md",
"destination": "/contracts/agents-api/source-files"
},
{
"source": "/contracts/agents-api/subagents.md",
"destination": "/contracts/agents-api/subagents"
},
{
"source": "/contracts/agents-api/vaults.md",
"destination": "/contracts/agents-api/vaults"
},
{
"source": "/contracts/agents-api/wire-semantics.md",
"destination": "/contracts/agents-api/wire-semantics"
}
]
}
4 changes: 2 additions & 2 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ Fixture browser acceptance uses loopback ports 18092 and 4174. Select unused por

## Change documentation

The repository-root `docs.json` configures the Mintlify site using the Almond theme, a dark graphite background, green accents and monospace headings. It references the existing Markdown sources; `.mintignore` excludes application code and styles from the site. Connect Mintlify to the repository root on the default branch. Use Node 22 LTS, install the CLI with `npm install -g mint`, and run `mint dev` from the repository root to preview the site. Before publishing, run `mint validate` and inspect its output for parsing errors as well as its exit status, then run `mint broken-links`.
The [website guide](https://github.com/MiniMax-AI/OpenAgentCore/blob/main/website/README.md) owns documentation navigation, local preview, validation and GitHub Pages publication.

Use `index.md` for published section indexes: Mintlify excludes `README.md` and `CONTRIBUTING.md` from pages. Keep relative Markdown links explicit (`./page.md` or `../page.md`) so they work in the repository and distribution. Each published Markdown page needs a matching `.md`-to-page redirect in `docs.json` for website navigation. Links to repository-only guides and source files should point to GitHub. Write literal angle-bracket placeholders inside code spans, and use Markdown reference comments (`[//]: # (comment)`) for generated-region markers so the sources render in both GitHub and Mintlify. Change generated content through its generator.
Use `index.md` for published section indexes. Keep relative Markdown links explicit (`./page.md` or `../page.md`) so they work in the repository and distribution. Links to repository-only guides and source files should point to GitHub. Write literal angle-bracket placeholders inside code spans, and use Markdown reference comments (`[//]: # (comment)`) for generated-region markers so the sources render in both GitHub and VitePress. Change generated content through its generator.

Find the owning source in the [documentation ownership map](https://github.com/MiniMax-AI/OpenAgentCore/blob/main/CONTRIBUTING.md#documentation-ownership) and follow the [documentation rules](https://github.com/MiniMax-AI/OpenAgentCore/blob/main/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](https://github.com/MiniMax-AI/OpenAgentCore/blob/main/CONTRIBUTING.md#contract-and-schema-rules).

Expand Down
4 changes: 3 additions & 1 deletion website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ pnpm --dir website preview # serve the build at http://127.0.0.1:4181
- Each page's source Markdown is published next to its HTML (`/docs/architecture.md`), and the `README` paths declared in `docs.json` redirect to their section index.
- Relative links from a page to a file that is not a published page, such as `CONTRIBUTING.md` or `openapi.yaml`, are rewritten to GitHub at build time, so the Markdown works unchanged on GitHub and on the site.

Site appearance and metadata are configured in `.vitepress/config.mts` and `.vitepress/theme/`.

The landing page lives in `.vitepress/theme/`. `landing-content.ts` holds its English and Chinese copy; every claim there must be backed by a page in `docs/` or `contracts/`, and its harness protocols follow [Model execution](../contracts/agents-api/model-execution.md).

## Publish

`make check-website` builds and tests the site. core-check runs it for changes under `website/` and to Node dependencies; `.github/workflows/website.yml` runs it for documentation-only pull requests and deploys `main` to GitHub Pages. A repository administrator enables Pages once: **Settings → Pages → Source: GitHub Actions**.
`make check-website` builds and tests the site. core-check runs it for pull requests that change the website, published documentation or relevant Node dependencies; `.github/workflows/website.yml` builds and deploys `main` to GitHub Pages. A repository administrator enables Pages once: **Settings → Pages → Source: GitHub Actions**.

The publishing step reads `html_url` directly from the GitHub Pages API and passes it to the build as `WEBSITE_URL`. VitePress derives the base path from that URL, supporting both `https://<owner>.github.io/<repository>/` and a custom domain set under **Settings → Pages → Custom domain**. An empty or invalid URL stops the build. Local builds omit `WEBSITE_URL` to serve from `/`.

Expand Down
Loading