docs: surface docs-folder conventions in AGENTS.md
Replace the two thin "docs live in …" lines with the conventions the docs/ READMEs establish: the three document types (PRD / research note / decision record) with their numbering and the PRD Status lifecycle, plus the cross-cutting rule that decision rationale stays self-contained in the repo rather than in Gitea issue threads. Points at the per-folder READMEs as the source of truth instead of duplicating them. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit was merged in pull request #101.
This commit is contained in:
@@ -35,8 +35,21 @@ the container lifecycle and the copying of skills and env vars into it.
|
|||||||
|
|
||||||
## Conventions
|
## Conventions
|
||||||
|
|
||||||
- Product requirement docs live in `docs/prds/`.
|
- Three kinds of doc, each with its own conventions in-folder; see
|
||||||
- Research notes live in `docs/research/`.
|
`docs/README.md` for when to write which:
|
||||||
|
- **PRDs** (`docs/prds/`) — one feature per file, numbered
|
||||||
|
`NNNN-kebab.md`. A `Status:` line tracks lifecycle: Draft → Active
|
||||||
|
(shipped to `main`) → Superseded/Retargeted. Format in
|
||||||
|
`docs/prds/README.md`.
|
||||||
|
- **Research notes** (`docs/research/`) — opinionated investigations;
|
||||||
|
unnumbered kebab-case, freeform and verdict-first. See
|
||||||
|
`docs/research/README.md`.
|
||||||
|
- **Decision records** (`docs/decisions/`) — ADR-lite, numbered
|
||||||
|
`NNNN-kebab.md`, for policies and non-feature decisions. See
|
||||||
|
`docs/decisions/README.md`.
|
||||||
|
- Keep decision rationale self-contained in the repo, not in Gitea
|
||||||
|
issue threads. Issues are an ephemeral inbox; the durable "why" lives
|
||||||
|
in a PRD, research note, or decision record.
|
||||||
- Low dependencies by default. The project is Python, stdlib-first (no
|
- Low dependencies by default. The project is Python, stdlib-first (no
|
||||||
runtime pip dependencies in the package itself; the only language
|
runtime pip dependencies in the package itself; the only language
|
||||||
runtime is the Python 3.13 used by the CLI + sidecars). Ask before
|
runtime is the Python 3.13 used by the CLI + sidecars). Ask before
|
||||||
|
|||||||
Reference in New Issue
Block a user