Skip to content

Add VitePress website with developer landing page and GitHub Pages deploy - #376

Merged
RyanLee-Dev merged 3 commits into
mainfrom
feat/vitepress-landing
Oct 1, 2026
Merged

RyanLee-Dev merged 3 commits into
mainfrom
feat/vitepress-landing

Conversation

@RyanLee-Dev

@RyanLee-Dev RyanLee-Dev commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a VitePress website (developer landing page + documentation) published to GitHub Pages.

  • Docs stay where they are. The content root is the repository root; docs/** and contracts/** keep their paths as URLs. No file under docs/ or contracts/ changes. The sidebar, the landing page's documentation index and /llms.txt are generated from docs.json at build time, so new pages flow in automatically. Each page's source is also served as .md, and the README paths in docs.json redirect to their section index. Relative links to repository-only files (CONTRIBUTING.md, openapi.yaml, …) are rewritten to GitHub at build time.
  • Landing page (EN /, 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 reuses architecture.png, development-architecture.png, architecture-api-surfaces.png and the EN/ZH console screenshots from docs/assets. Content follows README, quickstart, self-hosted, model-execution and the project write-up.
  • Deployment. .github/workflows/website.yml builds and tests on PRs that touch website inputs and deploys main to Pages. The build reads the Pages base path, so it works at /<repo>/ and on a custom domain. Registered in scripts/ci_plan.py as a lint-only workflow.
  • Tests. website/tests: navigation derivation, build output (every docs.json page has HTML + .md, redirects, llms.txt), and the landing harness table checked against internal/harnessconfig/builtin/catalog.json and contracts/agents-api/model-execution.md.

Needs a maintainer

  • Enable Pages once: Settings → Pages → Source: GitHub Actions (optionally set a custom domain there).
  • Mintlify coexists. docs.json and docs/development.md still describe the Mintlify site; this PR leaves docs/ untouched by request. If VitePress replaces Mintlify, a follow-up should update docs/development.md and remove the Mintlify-only fields/.mintignore.

Verification

  • pnpm --filter @oac/website build and test (12 pass); build also run with WEBSITE_BASE=/OpenAgentCore and 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.
  • Playwright screenshots at 1440px (dark/light, EN/ZH) and 390px (no horizontal overflow); content visible with JavaScript disabled; no console errors.
  • Independent review pass; its findings (name guard, mcode token limits, overclaims, deploy cancellation, Pages permission) are addressed.

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

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.
@mintlify

mintlify Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
openagentcore 🟢 Ready View Preview Oct 1, 2026, 9:56 AM

💡 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.
@RyanLee-Dev
RyanLee-Dev merged commit be1f966 into main Oct 1, 2026
23 checks passed

This branch was successfully deployed

1 active deployment
staging — 459c15ad Deployed Oct 1, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant