docs: VitePress site (EN/zh-CN), GitHub Pages workflow, and README trim#17
Merged
docs: VitePress site (EN/zh-CN), GitHub Pages workflow, and README trim#17
Conversation
Add package.json scripts (docs:dev, docs:build), VitePress config with GitHub Pages base path /onessh/, and guide content. Ignore node_modules and VitePress cache/dist outputs. Co-authored-by: lbb <mr@lbb00.com>
Add docs workflow using actions/upload-pages-artifact and deploy-pages. Extend CI with npm ci and docs:build. Link the published docs URL from both README files. Co-authored-by: lbb <mr@lbb00.com>
Add reference index page, per-route sidebars for guide vs reference, and nav dropdown. Update cross-links to VitePress routes; README paths for raw Markdown viewers. Co-authored-by: lbb <mr@lbb00.com>
Configure locales (root en + zh-CN under /zh/) with translated nav, sidebars, footer, and local search UI. Add full zh guide and reference pages. Trim README/ README.zh-CN to overview, quick start, build, test, install, and design links; point readers to the docs site. Co-authored-by: lbb <mr@lbb00.com>
Co-authored-by: lbb <mr@lbb00.com>
Close() can return before gzip backup completes; poll the audit directory until counts stabilize to avoid flaky CI. Co-authored-by: lbb <mr@lbb00.com>
cursor
bot
changed the title
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
2 participants
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.
Summary
This PR adds a VitePress documentation site under
docs/, with English (default) and 简体中文 (/zh/). It targets a GitHub project page athttps://tiangong-dev.github.io/onessh/(base: '/onessh/').Scope
docs/(English) — Home, guide, reference (architecture & security).docs/zh/— Parallel Chinese pages for the same sections.docs.yml— Build and deploy to GitHub Pages frommain(after merge).ci.yml—docsjob runsnpm ci+npm run docs:buildon every PR.internal/audittest — Poll after lumberjackClose()to avoid flaky rotation assertions on CI.After merge
mainwith these workflows will publish the site.Local preview
npm ci npm run docs:dev # EN: /onessh/ zh: /onessh/zh/Status: Ready for merge.