Skip to content

feat(docs): add Docusaurus Pages site#1443

Open
kongche-jbw wants to merge 1 commit into
alibaba:mainfrom
kongche-jbw:chore/gh-pages
Open

feat(docs): add Docusaurus Pages site#1443
kongche-jbw wants to merge 1 commit into
alibaba:mainfrom
kongche-jbw:chore/gh-pages

Conversation

@kongche-jbw

Copy link
Copy Markdown
Collaborator

Description

Replace the hand-maintained Pages source with a Docusaurus 3 site isolated
under website/. The site consumes the existing bilingual Markdown and
Changelog files through build-time generation, preserving them as the
canonical content sources. It also generates machine-readable Agent endpoints
from repository metadata, manifests, README files, and Clap definitions.
GitHub Pages is built and deployed through Actions without committing generated
output.

Canonical content sources and maintenance

The website does not maintain private copies of the project documentation.
Content must be updated through the following canonical sources:

  • Documentation:
    • docs/QUICKSTART.md and docs/QUICKSTART_zh.md
    • docs/BUILDING.md and docs/BUILDING_zh.md
    • docs/user-guide/{en,zh}/**
    • docs/developer-guide/{en,zh}/**
  • Changelog:
    • root CHANGELOG.md and CHANGELOG_zh.md
    • component-level src/<component>/CHANGELOG*.md
  • Agent endpoints:
    • generated from AGENTS.md, component manifests, README files,
      Changelog files, and Clap command definitions
  • Website presentation:
    • the homepage and product pages are maintained under website/src/pages/
    • shared product facts and platform support are maintained in
      website/content.config.ts
    • navigation and Footer are maintained in website/docusaurus.config.ts

English and Chinese documentation must use matching relative paths. New or
renamed documents must be added to both locales so that locale validation and
stable URL mapping continue to work.

Build-time scripts transform these sources into Docusaurus-compatible files
under website/.generated/. Maintainers must never edit or commit
website/.generated/, website/build/, or website/node_modules/.

When commands, installation behavior, component support, or platform
compatibility changes, update the underlying code and canonical documentation
first, then verify that the homepage and product pages still describe the
implemented behavior accurately.

Related Issue

closes #

Type of Change

  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • CI/CD or build changes

Scope

  • Multiple / Project-wide

Checklist

  • My code follows the project's code style
  • I have updated the documentation accordingly
  • Lock files are up to date (package-lock.json / Cargo.lock)

Testing

npm ci --prefix website
npm run validate:locales --prefix website
npm run build --prefix website
npm run check:links --prefix website
npm run typecheck --prefix website
git diff --check
Verified:
54 English and 54 Chinese documents are generated from canonical sources
project-level and component-level Changelogs are generated automatically
Agent index schema validation passes for 10 components
static link and duplicate DOM ID validation passes for 122 HTML files
English and Chinese locale switching works
desktop and 390 px mobile layouts work
Tokenless and Copilot Shell product pages render correctly
/install.sh, /agents/**, and /llms.txt remain available
fork Pages builds correctly under the /anolisa/ base path
Additional Notes
Preview: https://kongche-jbw.github.io/anolisa/
Generated files under website/.generated/ and website/build/ are ignored
and must not be committed. The first phase intentionally excludes Docusaurus
versioning, blogs, CMS integration, and external search.
After merging, a maintainer must:
Open repository Settings → Pages.
Set Build and deployment → Source to GitHub Actions.
Ensure the github-pages environment permits deployments from main.
Confirm the custom domain remains agentic-os.sh and enable HTTPS.
Verify /, /install.sh, and /agents/ before retiring the legacy
branch-based Pages deployment.

@github-actions github-actions Bot added scope:ci ./.github/ scope:documentation ./docs/|./*.md|./NOTICE labels Jul 12, 2026
@kongche-jbw

Copy link
Copy Markdown
Collaborator Author

@kongche-jbw
kongche-jbw force-pushed the chore/gh-pages branch 4 times, most recently from c5d7167 to 846adde Compare July 23, 2026 01:30
@kongche-jbw kongche-jbw self-assigned this Jul 23, 2026
@kongche-jbw
kongche-jbw force-pushed the chore/gh-pages branch 5 times, most recently from 93de124 to 825cfcd Compare July 23, 2026 02:36
@kongche-jbw
kongche-jbw marked this pull request as ready for review July 23, 2026 02:44
@kongche-jbw
kongche-jbw requested a review from casparant as a code owner July 23, 2026 02:44

@qoderai qoderai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] install.sh 镜像与版本切换风险

website/static/install.sh 直接从默认 OSS 镜像拉取 stable/指定版本二进制,仅依赖 SHA256 文本校验,若镜像配置错误或版本目录被清理,安装会静默回退为“跳过校验+仍尝试安装”,容易让用户误以为安装成功。建议:

  • 校验文件缺失时将安装视为失败(提示镜像/版本不可用),而不是继续安装
  • 在错误信息中打印当前 VERSION/MIRROR/TARGET,方便排查

[P2] Tokenless 产品页版本号依赖 schema 结构

website/src/pages/products/tokenless.tsxrepo-index.json 读取 Tokenless 版本并假设 components 中一定存在 id === 'tokenless'。若生成脚本或 schema 调整导致该组件临时缺失或重命名,页面会回退到 unversioned,但不会显式告警。建议:

  • 在版本缺失时明确提示“CLI version unavailable (check agent index generation)”或在构建时对该字段做断言

[P2] 404 与首页中文文案与文档导航耦合

404 页面 (website/src/pages/404.tsx) 和首页中文 CTA 部分直接硬编码了 /docs/quickstart 等路径,如果将来 Quickstart 入口或文档路径调整,只更新 docs 目录会导致导航指向过期 URL。建议:

  • 将 Quickstart/文档入口路径集中配置在生成脚本或 content.config.ts 中,由 homepage/404 共同引用,减少 URL 漂移风险。

🤖 Generated by QoderView workflow run

- Build a bilingual Docusaurus site from canonical repository documents.
- Unify README and website branding with responsive project assets.
- Deploy Pages only when site inputs change, with manual runs available.

Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:ci ./.github/ scope:documentation ./docs/|./*.md|./NOTICE

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant