Skip to content

feat(docs): add Docusaurus Pages site#1443

Draft
kongche-jbw wants to merge 4 commits into
alibaba:mainfrom
kongche-jbw:chore/gh-pages
Draft

feat(docs): add Docusaurus Pages site#1443
kongche-jbw wants to merge 4 commits 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.

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

- 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>
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