bingshuo/guanghu
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity
guanghu/site/reference/docs-maintenance.md
Guanghu Domestic Migration 9b41d51231
Some checks are pending
Auto-update PR branches / Update open PR branches (push) Waiting to run
Details
CI / Frontend Static Quality Checks (push) Waiting to run
Details
CI / Frontend Tests & Coverage (push) Waiting to run
Details
CI / Rust Tests & Quality Checks (push) Waiting to run
Details
CI / Linux build verification (push) Waiting to run
Details
Deploy docs / Build VitePress site (push) Waiting to run
Details
Deploy docs / Deploy to GitHub Pages (push) Blocked by required conditions
Details
Release (Alpha) / Compute alpha version (push) Waiting to run
Details
Release (Alpha) / Build release artifacts (push) Blocked by required conditions
Details
Release (Alpha) / GitHub Release (alpha) (push) Blocked by required conditions
Details
Release (Alpha) / Update docs and release pages (push) Blocked by required conditions
Details
chore: import sanitized domestic snapshot for REPO-004 
Source snapshot: 514ab1975951d94342ea38e64101d5a0f1c51c77
2026-07-17 15:55:28 +08:00

1.2 KiB
Raw Blame History

Docs Maintenance

The public docs live in the app repo so documentation changes can ship with behavior changes.

Update Docs When You Change

  • A Tauri command.
  • A new component or hook that changes user behavior.
  • A data model or frontmatter convention.
  • Git, AI, onboarding, or release behavior.
  • Public release pages, download metadata, or updater channels.
  • Platform support.
  • Keyboard shortcuts.

Suggested Workflow

  1. Make the code change.
  2. Update the matching concept, guide, or reference page.
  3. Add a troubleshooting page if the change creates a new failure mode.
  4. Run pnpm docs:build.
  5. Check the home page, search, release/download links, and changed docs pages in a browser.

Page Types

Type Purpose
Start Helps a new user get into the app.
Concepts Explains mental models.
Guides Teaches workflows.
Reference Gives stable facts and tables.
Troubleshooting Starts from a symptom and ends with recovery.

Review Checklist

  • Does the page describe current behavior?
  • Does it mention macOS primary and Windows/Linux supported-early status when platform support matters?
  • Are links relative and VitePress-compatible?
  • Can a user discover the page with local search?