Add VitePress website with developer landing page and GitHub Pages deploy - #376
Merged
Merged
Conversation
The website reads the existing docs/, contracts/ and docs.json in place: the sidebar, landing documentation index and llms.txt are generated from docs.json, page sources are published as .md copies, and README paths redirect to their section index. The landing page is bilingual and reuses the architecture diagrams and console screenshots from docs/assets.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Add a plan-selected website job that runs make check-website, so every tracked website source has a matching CI rule. website.yml now builds only documentation-only pull requests and deploys main.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a VitePress website (developer landing page + documentation) published to GitHub Pages.
docs/**andcontracts/**keep their paths as URLs. No file underdocs/orcontracts/changes. The sidebar, the landing page's documentation index and/llms.txtare generated fromdocs.jsonat build time, so new pages flow in automatically. Each page's source is also served as.md, and theREADMEpaths indocs.jsonredirect to their section index. Relative links to repository-only files (CONTRIBUTING.md,openapi.yaml, …) are rewritten to GitHub at build time./, ZH/zh/). Geeky terminal style: an animated ASCII rendering of the logo (decode-in, scan line, pointer-reactive, pauses off screen, honours reduced motion), an interactive Session builder that generates the real SDK call and shows Core's accept/reject verdict per harness/protocol, boundary → protocol doc map with animated packets, ASCII diagrams for the Session rules, a typing terminal for install, and an ASCII "ONE CORE. MANY AGENTS." outro. It reusesarchitecture.png,development-architecture.png,architecture-api-surfaces.pngand the EN/ZH console screenshots fromdocs/assets. Content follows README, quickstart, self-hosted, model-execution and the project write-up..github/workflows/website.ymlbuilds and tests on PRs that touch website inputs and deploysmainto Pages. The build reads the Pages base path, so it works at/<repo>/and on a custom domain. Registered inscripts/ci_plan.pyas a lint-only workflow.website/tests: navigation derivation, build output (everydocs.jsonpage has HTML +.md, redirects,llms.txt), and the landing harness table checked againstinternal/harnessconfig/builtin/catalog.jsonandcontracts/agents-api/model-execution.md.Needs a maintainer
docs.jsonanddocs/development.mdstill describe the Mintlify site; this PR leavesdocs/untouched by request. If VitePress replaces Mintlify, a follow-up should updatedocs/development.mdand remove the Mintlify-only fields/.mintignore.Verification
pnpm --filter @oac/website buildandtest(12 pass); build also run withWEBSITE_BASE=/OpenAgentCoreand every internal link, asset and redirect checked in a browser (0 broken).make check-names check-docs check-ci, name guard with the new files tracked, actionlint 1.7.12.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.