update-docs
Keep apps/docs in sync with merged product changes. On each run, audit recently merged PRs against docs content, update only drifted pages, verify with blume build, and open or update a docs/* PR — or report a clean no-op.
- License 许可
- MIT
- 最近更新
- 2026-11-01
- Stars
- ★ 5
- Forks
- 0
01 前言 Front Matter
- name
- update-docs
- description
- Keep apps/docs in sync with merged product changes. On each run, audit recently merged PRs against docs content, update only drifted pages, verify with blume build, and open or update a docs/* PR — or report a clean no-op.
03 SKILL.md 正文
Update docs — sync apps/docs with merged PRs
Upstream workflow: npx skills add haydenbleasel/blume --skill blume-update-docs. This local skill encodes it for scheduled agents in this repo.
When to use
- Scheduled — weekly (or similar) run to catch docs drift from merged PRs.
- On demand — after a batch of merged PRs that may have changed public API surfaces, seams, or Blume config.
Workflow
- Collect merged PRs in the lookback window (default 7 days):
git log --since="7 days ago" --merges --first-parentandgh pr list --state merged --search "merged:>$DATE". Done: every merged PR in the window listed with title, number, and surfaces touched. - Drop feature-flagged work — skip PRs/commits touching flag-gated code; never document unreleased surfaces. Done: flag-gated PRs removed from the list.
- Map changed surfaces to docs pages — trace diffs in
src/core/,src/adapters/**,package.jsonexports,blume.config.ts/apps/docs/**, and TypeDoc-facing JSDoc to the pages that document them (content/reference/api/**,content/guides/**,content/recipes/**,content/concepts/**,content/adapters/**, plus homepage_home/**when behavior framing changed). Regenerate API MDX viabun run docs:apiwhen public exports/JSDoc drifted. Done: every changed public surface mapped to zero or more docs pages. - Edit only drifted facts — signatures, option tables, behavior descriptions, entry-point peers. Use
docs-voice; do not rewrite stable prose. Competitor framing stays store persist middlewares only. Done: every drifted fact updated; no stable prose touched. - Verify —
bun run docs:validate -- --strict && bun run docs:check -- --isolated && bun run docs:build -- --isolated(or root filter equivalents); fix until green. Do not commit if any fail. Perverify-after-each-step. Done: all three green. - Open or update a PR on branch
docs/sync-<date>with a summary of what drifted and the fixes. Label itdocsso merge deploys/persist(docs-governance/LIFECYCLE.md§ README surfaces). Follow commit/PR conventions; never--no-verify(no-bypass-hooks). Done: PR open withdocslabel and drift summary, or step 7 applies. - Clean no-op — if nothing drifted, report the PRs checked and surfaces audited; do not open a PR. Done: report lists every PR checked and every surface audited.
Boundaries
- Only
apps/docs/(+ root scripts/config that the docs app requires, e.g.typedoc.jsonwhen regenerating API) — never edit maintainerdocs/plans/research in a sync PR; never edit librarysrc/in a docs-sync PR. - Minimal diffs — drifted facts only; no cosmetic rewrites, unrelated refactors, or removing source comments in touched files (
authoring-discipline). - No PR on a clean no-op; no commit on a failing build.
Reference
- Verify loop:
verify-after-each-step·harden-pr(lite before commit, full before merge) - Authoring:
authoring-discipline - Voice/tone/format for the public site:
docs-voice - Docs site scope:
docs-governance(governsdocs/; this skill governsapps/docs/sync only)
04 同仓库更多 Skills
vue-persist
Gate Vue 3 UI on Persist hydration with useHydrated (shallowRef). Use in setup/effectScope when avoiding flash of default state on async backends.
svelte-store-persist
Gate Svelte store-based UI on Persist hydration with hydratedStore (Readable). Use for Svelte 3–4 or Svelte 5 apps that still use stores; runes UI → svelte-persist.
svelte-persist
Gate Svelte 5 runes UI on Persist hydration with hydratedRune (.current). Use for Svelte 5; for stores / Svelte 3–4 use svelte-store-persist.
solid-persist
Gate Solid UI on Persist hydration with useHydrated (Accessor). Use when avoiding flash of default state on async backends; read hydrated() in reactive scopes.
react-persist
Gate React UI on Persist hydration with useHydrated + toHydrationSignal. Use when avoiding flash of default state on async backends (IndexedDB), SSR snapshot true, or wiring HydrationSignal into React 18/19.
preact-persist
Gate Preact UI on Persist hydration with useHydrated (preact/compat useSyncExternalStore). Use when avoiding flash of default state on async backends or wiring HydrationSignal into Preact.