Skip to content

docs(playbook): add a task index, group and number the procedures, deprecate instead of rename - #2433

Merged
braboj merged 4 commits into
mainfrom
docs/playbook
Nov 2, 2026
Merged

braboj merged 4 commits into
mainfrom
docs/playbook

Conversation

@braboj

@braboj braboj commented Nov 1, 2026

Copy link
Copy Markdown
Collaborator

The playbook had 27 procedures in no order and no index. It now opens with a task index and groups the procedures, numbered to h3.

Group Procedures
1. Templates Add, review, drain a lesson, replace a file, change a section ID, validate, score, audit redundancy, ask models
2. Checks Run the test suite, write or narrow a check, ship a hook, control-test
3. Issues and pull requests Triage, pick up, groom, submit a PR
4. Decision records Write a decision record
5. Releases Release a new version
6. Forks and projects Sync a fork, generate a context file, vendor, adopt an update
7. Documents and audits Survey consumers, retire a document, 360 audit
8. Sessions Wrap up a session

Content changes:

  • "Rename a template file" → "Replace a template file": deprecate-and-replace, since paths are frozen in 3.x (spec 8.7, 8.8)
  • "Rename a section ID" → "Change a section ID": frozen until 4.0.0; new IDs only after a shipped section's last line
  • "Author a new ADR" → "Write a decision record"
  • History and incident narration removed; the rules they supported stay, in present tense
  • Every fenced command block kept; the titles other files cite kept word for word

Anchor links in README and CONTRIBUTING follow the new numbered headings.

Checks run: smoke, markdownlint, doc figures, heading numbers.

Closes no issue: part of the documentation review.

🤖 Generated with Claude Code

https://claude.ai/code/session_01DpT5xSVK2FLNdArtRtNjLH

…precate instead of rename

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DpT5xSVK2FLNdArtRtNjLH
@braboj braboj added the changelog:none No changelog entry: a consuming project would not notice label Nov 1, 2026
braboj and others added 3 commits November 1, 2026 17:36
…eps, bound the unpublished release

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DpT5xSVK2FLNdArtRtNjLH
@braboj
braboj merged commit 4b6cd31 into main Nov 2, 2026
16 checks passed
@braboj
braboj deleted the docs/playbook branch November 2, 2026 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:none No changelog entry: a consuming project would not notice

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant