From 4a86d5b512fafed4e80679945fee3d52eba46c04 Mon Sep 17 00:00:00 2001 From: yuanhe Date: Thu, 1 Oct 2026 20:46:15 +0800 Subject: [PATCH] chore(website): remove unused Mintlify configuration --- .mintignore | 17 ---- docs.json | 215 ---------------------------------------- docs/development.md | 4 +- scripts/ci_plan_test.py | 2 +- website/README.md | 2 + 5 files changed, 5 insertions(+), 235 deletions(-) delete mode 100644 .mintignore diff --git a/.mintignore b/.mintignore deleted file mode 100644 index 8f62c71c..00000000 --- a/.mintignore +++ /dev/null @@ -1,17 +0,0 @@ -# Publish guides and contracts; repository implementation stays on GitHub. -apps/ -deploy/ -example/ -internal/ -packages/ -scripts/ -services/ -AGENTS.md -README.zh-CN.md -**/*.js -**/*.jsx -**/*.ts -**/*.tsx -**/*.mjs -**/*.cjs -**/*.css diff --git a/docs.json b/docs.json index 5e2be81f..536edfd3 100644 --- a/docs.json +++ b/docs.json @@ -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": [ { @@ -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", @@ -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" } ] } diff --git a/docs/development.md b/docs/development.md index 1a48639a..2d223127 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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). diff --git a/scripts/ci_plan_test.py b/scripts/ci_plan_test.py index acf11146..faf1ee44 100644 --- a/scripts/ci_plan_test.py +++ b/scripts/ci_plan_test.py @@ -310,7 +310,7 @@ def plan(self, paths, event=None, ref=""): return plan, diff def test_doc_site_configuration_and_docs_only_push_skip_product_checks(self): - paths = ["docs.json", ".mintignore", "docs/getting-started/index.md", "README.md"] + paths = ["docs.json", "docs/getting-started/index.md", "README.md"] self.assertEqual(set(ci.select(paths)["jobs"]), {"hygiene"}) plan, diff = self.plan(paths) self.assertEqual(set(plan["jobs"]), {"hygiene"}) diff --git a/website/README.md b/website/README.md index 66f1cc8f..bd64391d 100644 --- a/website/README.md +++ b/website/README.md @@ -19,6 +19,8 @@ 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