From fe53984c4092ef00cab51b1ddd77c5b890786670 Mon Sep 17 00:00:00 2001 From: Ogulcan Celik Date: Tue, 19 May 2026 05:16:50 +0300 Subject: docs: stage website docs for next release --- AGENTS.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index f87866a0..9da6753a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -52,9 +52,9 @@ Unit tests live next to the code (`#[cfg(test)] mod tests`). If you add behavior - Conventional commits, lowercase, no emojis. - Do not edit root `README.md` or `CHANGELOG.md` during normal feature or fix work unless explicitly asked. Maintainers prepare `docs/next/README.md` and `docs/next/CHANGELOG.md` during release review. -- Treat website docs under `website/src/content/docs/` as the latest released public docs. Do not document unreleased behavior there during normal feature or fix work. -- Treat `docs/next/README.md` and `docs/next/CHANGELOG.md` as next-release staging for the root README and changelog. -- Before release, copy approved next-release docs into their released locations: `docs/next/README.md` to `README.md`, `docs/next/CHANGELOG.md` to `CHANGELOG.md`, and approved website doc changes to `website/src/content/docs/`. `just release-docs-check` verifies README/changelog sync, the website docs are present, and the removed root docs stay removed. +- Treat website docs under `website/src/content/docs/` as the latest released public docs. These are Astro Starlight MDX docs published on herdr.dev. Do not document unreleased behavior there during normal feature or fix work. +- Treat `docs/next/README.md` and `docs/next/CHANGELOG.md` as next-release staging for the root README and changelog. Treat `docs/next/website/src/content/docs/` as a full next-release mirror of `website/src/content/docs/`; these staged MDX files are the source for the next herdr.dev docs. +- During normal work, update `docs/next/website/src/content/docs/` for unreleased website doc changes, not `website/src/content/docs/`. Before release, copy the approved mirror back to `website/src/content/docs/`. `just release-docs-check` verifies README/changelog sync, the website docs mirror is 1:1 with released website docs, and the removed root docs stay removed. - Put local PRDs, planning notes, and exploratory specs under `.prd/`; that directory is ignored and locally controlled. - When a normal feature or fix commit relates to a GitHub issue, add a commit body line `refs #` after the subject. Use this shape: ```text -- cgit v1.2.3