Skip to content

docs(site): add bilingual Docusaurus website for GitHub Pages - #81

Merged
luoxuanzao merged 2 commits into
mainfrom
feat/docs-site
Sep 29, 2026
Merged

luoxuanzao merged 2 commits into
mainfrom
feat/docs-site

Conversation

@luoxuanzao

Copy link
Copy Markdown
Member

Summary

  • Adds a Docusaurus site under docs/ with English and 简体中文 locales (introduction, installation, features, FAQ), mirroring the setup used by better-harness
  • Adds .github/workflows/pages.yml to build and deploy the site to GitHub Pages on changes to docs/ or assets/
  • Shared assets (preview.png) are synced into the site at build time via docs/scripts/sync-assets.mjs, avoiding duplicate large files in the repo

Site

https://qoderai.github.io/qoderian/docs/introduction (once merged and Pages is set to GitHub Actions — already enabled)

Test plan

  • npm ci && npm run build passes for both locales locally
  • All 8 doc pages + image return 200 via local docusaurus serve
  • / and /zh-Hans/ redirect to the docs introduction
  • Verify first deployment after merge

Adds a Docusaurus site under docs/ (en + zh-Hans) with introduction,
installation, features, and FAQ pages, plus a GitHub Actions workflow
that builds and deploys it to GitHub Pages on changes to docs/.
Clears the two moderate advisories (GHSA-rpw4-54j3-4h4q,
GHSA-2vr4-cq9g-pvrc) that fail `npm run audit:prod` in CI.
@luoxuanzao
luoxuanzao merged commit aebc6c7 into main Sep 29, 2026
10 checks passed
@luoxuanzao
luoxuanzao deleted the feat/docs-site branch September 29, 2026 15:19
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