feat(docs): add Docusaurus Pages site#1443
Open
kongche-jbw wants to merge 1 commit into
Open
Conversation
Collaborator
Author
kongche-jbw
force-pushed
the
chore/gh-pages
branch
4 times, most recently
from
July 23, 2026 01:30
c5d7167 to
846adde
Compare
kongche-jbw
force-pushed
the
chore/gh-pages
branch
5 times, most recently
from
July 23, 2026 02:36
93de124 to
825cfcd
Compare
kongche-jbw
marked this pull request as ready for review
July 23, 2026 02:44
kongche-jbw
force-pushed
the
chore/gh-pages
branch
from
July 23, 2026 02:44
825cfcd to
d4e346b
Compare
There was a problem hiding this comment.
[P1] install.sh 镜像与版本切换风险
website/static/install.sh 直接从默认 OSS 镜像拉取 stable/指定版本二进制,仅依赖 SHA256 文本校验,若镜像配置错误或版本目录被清理,安装会静默回退为“跳过校验+仍尝试安装”,容易让用户误以为安装成功。建议:
- 校验文件缺失时将安装视为失败(提示镜像/版本不可用),而不是继续安装
- 在错误信息中打印当前
VERSION/MIRROR/TARGET,方便排查
[P2] Tokenless 产品页版本号依赖 schema 结构
website/src/pages/products/tokenless.tsx 从 repo-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 Qoder • View 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>
kongche-jbw
force-pushed
the
chore/gh-pages
branch
from
July 25, 2026 07:42
d4e346b to
e899de5
Compare
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.
Description
Replace the hand-maintained Pages source with a Docusaurus 3 site isolated
under
website/. The site consumes the existing bilingual Markdown andChangelog 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:
docs/QUICKSTART.mdanddocs/QUICKSTART_zh.mddocs/BUILDING.mdanddocs/BUILDING_zh.mddocs/user-guide/{en,zh}/**docs/developer-guide/{en,zh}/**CHANGELOG.mdandCHANGELOG_zh.mdsrc/<component>/CHANGELOG*.mdAGENTS.md, component manifests, README files,Changelog files, and Clap command definitions
website/src/pages/website/content.config.tswebsite/docusaurus.config.tsEnglish 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 commitwebsite/.generated/,website/build/, orwebsite/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
Scope
Checklist
package-lock.json/Cargo.lock)Testing