aboutsummaryrefslogtreecommitdiff
path: root/.pi
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-05-19 05:06:43 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-05-19 05:08:00 +0300
commitee6a8f9411a3d8f0105ed5d793bc44dafcd9ce2b (patch)
treea1c5fb333e701261160fd37f144e3b8a0c3fefa1 /.pi
parentc5e1a20ad30f400a951abe154385d8f5931bebf3 (diff)
docs: move public references to website docs
Diffstat (limited to '.pi')
-rw-r--r--.pi/prompts/pre-release-audit.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/.pi/prompts/pre-release-audit.md b/.pi/prompts/pre-release-audit.md
index 4ff2ecd4..f3d9ce8f 100644
--- a/.pi/prompts/pre-release-audit.md
+++ b/.pi/prompts/pre-release-audit.md
@@ -61,26 +61,26 @@ Process:
- Preserve the existing changelog style and sections: `Added`, `Changed`, `Fixed`, `Removed`, and `Breaking Changes` when applicable.
7. Audit next-release public docs.
- - Treat root `README.md`, `CONFIGURATION.md`, `INTEGRATIONS.md`, and `SOCKET_API.md` as the latest released public docs.
- - Treat `docs/next/README.md`, `docs/next/CONFIGURATION.md`, `docs/next/INTEGRATIONS.md`, and `docs/next/SOCKET_API.md` as the next-release versions.
- - Compare meaningful user-facing changes in the range against `docs/next/` first.
- - Flag missing next-release docs for new or changed features, commands, config keys, protocol behavior, integrations, defaults, and compatibility notes.
- - Compare `docs/next/` against the root docs. Flag each difference as intended to ship in this release, stale, or needing user decision.
- - Also audit `website/` and example config snippets for release readiness, but keep them aligned with the latest published release unless the user explicitly asks for prerelease 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.
+ - 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.
8. Verify finalization state.
- - Before `just release`, approved `docs/next/*` files must be copied to their root counterparts.
+ - 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.
- Run or recommend:
```bash
just release-docs-check
```
- - This check must include `README.md`, `CONFIGURATION.md`, `INTEGRATIONS.md`, `SOCKET_API.md`, and `CHANGELOG.md`.
+ - This check must include root `README.md`, root `CHANGELOG.md`, the removed root doc files, and the required website 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` and any relevant `docs/next/` files first.
- - When asked to finalize release docs, copy approved `docs/next/` files into the matching root files and run `just release-docs-check`.
+ - 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`.
Output format: