feat(docs): add Docusaurus Pages site#1443
Draft
kongche-jbw wants to merge 4 commits into
Draft
Conversation
- build bilingual docs and changelogs from canonical sources - publish validated Pages artifacts through GitHub Actions - add responsive product pages and machine-readable endpoints Assisted-by: Codex Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>
- configure fork builds for the repository Pages subpath - retain the production domain behavior on upstream main - remove the production CNAME from fork preview artifacts Assisted-by: Codex Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>
- make package tarballs reachable from GitHub-hosted runners - keep the registry configuration isolated in website Assisted-by: Codex Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>
Collaborator
Author
- Group user value into three workload paths while keeping components modular. - Rename navigation to components because its entries are software units. - Add locale-specific dev startup; production still builds both locales. Assisted-by: Codex:0.144.3 Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>
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