diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:16:50 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:16:50 +0300 |
| commit | fe53984c4092ef00cab51b1ddd77c5b890786670 (patch) | |
| tree | 278ad736c20a5eb9f4c3d8cc77a2a71383f831fe /.pi | |
| parent | ee6a8f9411a3d8f0105ed5d793bc44dafcd9ce2b (diff) | |
docs: stage website docs for next release
Diffstat (limited to '.pi')
| -rw-r--r-- | .pi/prompts/pre-release-audit.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/.pi/prompts/pre-release-audit.md b/.pi/prompts/pre-release-audit.md index f3d9ce8f..11e42eb0 100644 --- a/.pi/prompts/pre-release-audit.md +++ b/.pi/prompts/pre-release-audit.md @@ -62,25 +62,25 @@ Process: 7. Audit next-release public docs. - Treat root `README.md` and `website/src/content/docs/` as the latest released public docs. - - Treat `docs/next/README.md` as the next-release root README. - - Compare meaningful user-facing changes in the range against root README and website docs. + - Treat `docs/next/README.md` as the next-release root README, and `docs/next/website/src/content/docs/` as the full next-release mirror of website docs. + - Compare meaningful user-facing changes in the range against next-release docs first. - Flag missing release docs for new or changed features, commands, config keys, protocol behavior, integrations, defaults, and compatibility notes. - - Compare `docs/next/README.md` against root `README.md`. Flag each difference as intended to ship in this release, stale, or needing user decision. - - Also audit website docs and example config snippets for release readiness. + - Compare `docs/next/README.md` against root `README.md`, and compare the staged website-doc mirror against `website/src/content/docs/`. Flag each difference as intended to ship in this release, stale, or needing user decision. + - Also audit example config snippets for release readiness. 8. Verify finalization state. - - Before `just release`, approved `docs/next/README.md` must be copied to root `README.md`, approved website doc changes must be present under `website/src/content/docs/`, and the deleted root doc files must stay deleted. + - Before `just release`, approved `docs/next/README.md` must be copied to root `README.md`, approved staged website docs must be copied from `docs/next/website/src/content/docs/` to `website/src/content/docs/`, and the deleted root doc files must stay deleted. - Run or recommend: ```bash just release-docs-check ``` - - This check must include root `README.md`, root `CHANGELOG.md`, the removed root doc files, and the required website docs. + - This check must include root `README.md`, root `CHANGELOG.md`, the removed root doc files, and exact 1:1 sync between `docs/next/website/src/content/docs/` and `website/src/content/docs/`. - Do not run `just release` unless the working tree is clean and the docs check passes. 9. Apply changes only when asked. - Do not edit files during the audit unless the user explicitly asks you to apply fixes. - - When asked to apply audit fixes, update `docs/next/CHANGELOG.md`, `docs/next/README.md`, and any required website docs. - - When asked to finalize release docs, copy approved next-release README and changelog into root, update the matching website docs, then run `just release-docs-check`. + - When asked to apply audit fixes, update `docs/next/CHANGELOG.md`, `docs/next/README.md`, and any required staged website docs under `docs/next/website/src/content/docs/`. + - When asked to finalize release docs, copy approved next-release README and changelog into root, copy approved staged website docs into `website/src/content/docs/`, then run `just release-docs-check`. Output format: |