docs: make docs-fold the single writer of shared documentation
Every item wrote the shared, append-only docs (android/README.md, docs/cli.md and the packaged skill references), so every merge conflicted on prose. Keep the duty to notice stale docs; move the writing to one deliberate place. - Per-item note, not a shared edit. An item that makes a shared document stale writes docs/notes/<slug>.md - unique per item, so two items never touch the same file - and commits that note with its change. It never edits a README, topic doc or packaged skill reference itself. - One writer. The manual-only docs-fold pipeline, bundled as the fifth starter examples/docs-fold.md, folds every note under docs/notes/ into the shared document it names and deletes the consumed notes in its own commit; an empty notes directory is a success no-op. Operator trigger: pipelines new "Docs fold" --template docs-fold --no-open; pipelines submit <draft.md>; pipelines run "Docs fold". - Implemented where the convention lives: orchestration.md (brief item 5, the hard-constraint bullet, a "Single documentation writer" section and the "Pipeline choice" committer bullet), the canonical committer checklist in format.md (new step 6), the committer prompts in examples/task.md and examples/three-stage.md, the new examples/docs-fold.md with its catalog and README entries, and the repository guideline AGENTS.md. Test-expectation counts (examples/catalog_test.go, internal/server/templates_test.go, scripts/smoke-first-install.py) follow the fifth starter. Reflected where it belongs: the packaged templates (examples/task.md, examples/three-stage.md, the new examples/docs-fold.md), the packaged skill references (orchestration.md, format.md) and the repo guideline AGENTS.md all carry the new convention. No new reference file was added, so install.go's managed inventory is unchanged. The shared descriptive docs were deliberately not rewritten: this change makes README.md:191, docs/cli.md:170 and internal/author/skill/references/operations.md:13 name four starters where there are now five. Those stay as they are - correcting them now is exactly the per-item shared edit this change removes - and the stale-doc note docs/notes/docs-fold-single-writer.md records each one for the docs-fold writer to fold. Nothing else needed updating. No new dependency; no Android, Gradle, server, installer, Docker or published-definition change; no definition published over the running pipelines. Evidence: go test -count=1 ./... passed; go build ./... and go vet on the touched packages clean; ./internal/author/... covers embedding, reference links, the managed inventory and install/upgrade/protection; ./examples/... validates the fifth starter and its manual-only, committer-terminated graph; ./internal/server/... covers the served catalog. Not run: the docs-fold writer against the shared docs (nothing to fold yet); no install or deploy. (cherry picked from commit f29656cf084d7eee2e033f2a37a9d231d7acaaf0)
This commit is contained in:
+6
-1
@@ -71,7 +71,12 @@ Commit this run's change locally. Never push, tag, deploy or rewrite history.
|
||||
Select the run's changed paths from input.server_changed_files (the runner's
|
||||
captured evidence) and the worker's declared changed_files, and stage their union
|
||||
of paths that still exist, keeping any exclusions. Inspect the staged diff before
|
||||
committing; never commit unrelated work, secrets or generated artifacts. Pre-commit
|
||||
committing; never commit unrelated work, secrets or generated artifacts. Follow the
|
||||
documentation-note step of the committer checklist in `references/format.md`: when the
|
||||
change makes a shared document stale, stage the item's own documentation note
|
||||
(`docs/notes/<slug>.md`) with the change, and never edit a shared document (a README,
|
||||
topic docs or the packaged skill references) here; a single documentation writer folds
|
||||
notes later. Pre-commit
|
||||
checklist: confirm the staged paths are this run's change; run the repository's
|
||||
required checks and record the exact commands and observed results in an
|
||||
`# evidence` section; do not commit if a required check fails, return blocked
|
||||
|
||||
Reference in New Issue
Block a user