Repository navigation
docs(kinds): say what a kind's battery is, in one place - #689
dilux-bot[bot] wants to merge 14 commits into
Conversation
The draft pull request opens before any code: the Spec as its checklist.
|
The pull request's board
🤖 AI-generated · Claude Opus 5.5 (Anthropic) |
kinds/README.md gets a section, "The battery", whose one paragraph says what a battery is, the pack key it comes from, the wordpress-plugin example, how it differs from the workflows every repository gets, and how a repository runs it through its callers. The earlier mentions on the page link to it. Assisted-by: Claude Opus 5.5 (Anthropic)
The first "battery" in docs/configuration.md, docs/adopting.md and docs/maintaining.md links to the definition in kinds/README.md. The configuration page is generated, so its link is in the `says:` of the `workflows` setting in policy/settings-schema.yml, and the page is written again from it. Assisted-by: Claude Opus 5.5 (Anthropic)
|
Hint: the conventions check fails because the title says 🤖 AI-assisted · Claude Opus 5.5 (Anthropic) |
Claude review · risk high · complexity low · type docsNothing to fix. First review. The change adds a No findings. Policy floor: high (touches high-risk paths: kinds/README.md, policy/settings-schema.yml, tests/workflows/test_battery_doc.py). Reviewed b4db77d (whole pull request; review 1 of 5 automatic). Author trusted for auto-merge: false. 🤖 AI review · claude-sonnet-5-5 (Anthropic) · $0.20, 7 turns |
📝 What changes
Add a short section
## The batterytokinds/README.md, right after thepack.ymltable in "What a pack holds" (its heading gives the stable anchor#the-battery), holding one paragraph that says: a kind's battery is the reusable workflows in.github/workflows/that check, test, release and publish a repository of that kind, as listed under the pack'sworkflowskey; for wordpress-plugin,plugin-checks-wp.yml,plugin-tests-wp.yml,plugin-release-wp.ymlandplugin-publish-wp.yml; it differs from the workflows every repository gets whatever its kind (repos.ymlevery-repository:issues.yml,pull-request-comments.yml, andorg-pull-request.ymlthat the organisation's ruleset requires) because only a repository of that kind gets it; and a repository runs it through its callers, the files fromworkflow-templates/thatsync-repos.py callerswrites into its.github/workflows/and that name the battery's workflows (GitHub cannot pick a reusable workflow from data). The earlier mentions inkinds/README.md(intro, theworkflowsrow) link to that section.In
docs/adopting.mdanddocs/maintaining.md, the first "battery" on each page becomes a link to../kinds/README.md#the-battery.docs/configuration.mdis generated byscripts/settings.py docsfrompolicy/settings-schema.yml(test_configuration_doc.pyfails a hand edit), so the link goes into thesays:of theworkflowssetting there and the page is regenerated withpython3 scripts/settings.py docs > docs/configuration.md. That is a change of words in a data file underpolicy/, not of a workflow, script or pack;docs/model.mdhas no glossary and no "battery", so it is left alone. Nothing widens any permission, secret, lane or limit.💡 Why
Closes #688. The autopilot works it here in the open: one commit per criterion, each box ticked once its commit is pushed.
🎯 Acceptance criteria
kinds/README.md, when a reader looks for what a battery is, then one paragraph defines it, names the pack key it comes from (workflows), gives the wordpress-plugin example, and says how it differs from the workflows every repository gets and how a repository runs it (its callers).Test: tests/workflows/test_battery_doc.py
docs/configuration.md,docs/adopting.mdanddocs/maintaining.md, when they say "battery", then the first mention on each page links to that definition.Test: tests/workflows/test_battery_doc.py
🧭 Decisions
🙌 Credits
🧪 How I tested it
tests/workflows/test_battery_doc.py(new, 8 tests) checks thatkinds/README.mdhas one paragraph under## The battery. That paragraph names theworkflowskey, lists every workflow in the wordpress-plugin pack, names the callers inrepos.ymlevery-repositoryandorg-pull-request.yml, and says how a repository runs the battery through its callers. The tests also check that the first "battery" ondocs/configuration.md,docs/adopting.mdanddocs/maintaining.mdis the link to../kinds/README.md#the-battery, and that the configuration page's link comes frompolicy/settings-schema.yml.docs/configuration.mdwithpython3 scripts/settings.py docs.tests/workflows/test_configuration_doc.pyandsettings.py checkpass.tests/suite passes with pytest 9.1.1 (270 passed, 1 skipped).--testin the scripts job. Four fail on this runner and fail the same way at the base commit:plugin-i18n.sh(no gettext),design-lint.py(no stylelint),review-brief.shandrunner-vm/dx-runner-slot.sh(environment). The repository has nomake pre-pr.local-review.sh --no-claudereports the conventions as OK.🤖 AI-generated · Claude Opus 5.5 (Anthropic)