Merge branch 'main' into session-activity
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# docs-fold single documentation writer
|
||||
|
||||
## What this item changed
|
||||
|
||||
Per-item workflows no longer edit shared documentation themselves. The convention now
|
||||
lives in `internal/author/skill/references/orchestration.md` (brief item 5, the
|
||||
hard-constraint bullet, "Single documentation writer", and the "Pipeline choice"
|
||||
committer bullet), the canonical committer checklist in
|
||||
`internal/author/skill/references/format.md` (step 6), the bundled committer prompts in
|
||||
`examples/task.md` and `examples/three-stage.md`, and the repository guideline
|
||||
`AGENTS.md`.
|
||||
|
||||
The chosen mechanism is a **per-item note file** at `docs/notes/<slug>.md`: when a
|
||||
change makes a shared document stale, the item records what changed and what should
|
||||
change there, commits that note with its own change, and never edits a shared document.
|
||||
The chosen **single writer** is the manual-only `docs-fold` pipeline, added as a fifth
|
||||
bundled starter at `examples/docs-fold.md` and listed in `examples/catalog.go` and
|
||||
`examples/README.md`. Its `fold` stage reads every note under `docs/notes/`, folds each
|
||||
into the shared document it names, and deletes the consumed notes in its own commit.
|
||||
|
||||
## Shared documents this change makes stale
|
||||
|
||||
Adding the fifth starter (`docs-fold`) makes the following documents' starter counts
|
||||
wrong. They were deliberately **not** edited by this item; the `docs-fold` writer should
|
||||
correct them when it next folds notes.
|
||||
|
||||
- `README.md:191` — "To skip authoring, use **:templates**, choose one of the four
|
||||
generic starters," should read "five generic starters".
|
||||
- `docs/cli.md:170` — "Use `:templates` for four simple, manual-only starters: task,
|
||||
review, research, and plan/implement/review." should say five starters and name
|
||||
`docs-fold` (fold accumulated documentation notes, then commit locally).
|
||||
- `internal/author/skill/references/operations.md:13` — "Four optional generic starters
|
||||
are task, review, research and three-stage;" should read "Five optional generic
|
||||
starters are task, review, research, three-stage and docs-fold;".
|
||||
|
||||
## Do not change
|
||||
|
||||
- `docs/first-version-testing.md:148` and the dated records in
|
||||
`docs/installation-verification.md` describe a past fixture run at the time it ran;
|
||||
they are dated evidence, not current counts, and stay as they are.
|
||||
Reference in New Issue
Block a user