docs(pipeline-crew): plugin How-to — add a role · configure personalization · reboot · carry a §CP PR · retire a crew#3611
Merged
Conversation
…nalization · reboot · carry a §CP PR · retire a crew (#3566) Author the task-oriented How-to quadrant for the pipeline-crew PLUGIN surface, beside REFERENCE.md/EXPLANATION.md/PERSONALIZATION.md. Single-mode Diátaxis how-to: goal-focused recipes for add a role, configure personalization, reboot the crew, carry a §CP PR (approve-then-ship-it-enqueue per ADR 0135), and retire a crew — each linking into the plugin Reference/Explanation rather than re-explaining. No cross-links into the pipeline-crew-mcp package docs (surface separation). Wire a minimal Layout-tree row + See-also link into the README. Fixes #3566 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
3 tasks
Member
Author
|
review-code: PASS @ 7bdb45b — merge-ready Verified PR #3611 against the acceptance criteria of #3566, one at a time:
Notes:
Run-evidence bundle: N/A — docs-only PR (two Read the PR head (§HEAD): all files under review sourced from All criteria pass. This PR is merge-ready. review-code does not merge — |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Authors the How-to Diátaxis quadrant for the
pipeline-crewplugin surface:claude-plugins/pipeline-crew/HOW-TO.md, besideREFERENCE.md/EXPLANATION.md/PERSONALIZATION.md. Single-mode, task-oriented (precedent: Wave 3B split, #3392).Five goal-focused recipes against a running crew:
/spawn-rolea scaled engine or the HITL cartographer; the roster-law cardinality rule; adding a brand-new role kind is a config + runtime change.crew.config.jsoncfrom the template; change a dimension later; the optionalcliVersionpin.retire-role+spawn-role) or the whole crew (stand-down+stand-up); a reboot is how a config edit takes effect; no partial crew.retire-roleone member orstand-downthe whole crew; drain in-flight lanes first.Each recipe links into the plugin Reference and Explanation rather than re-deriving roster law or the §CP gate.
Surface separation
pipeline-crew-mcppackage docs tree — all links stay within the plugin dir (README/REFERENCE/EXPLANATION/PERSONALIZATION,commands/) plus ADR pointers. Substrate CLI subcommands (stand-down,retire-role) are referenced by command name, consistent with how the README/commands already reference the substrate.README wiring (minimal, localized)
HOW-TO.mdLayout-tree row and one See-also link only — no reorder/reformat of existing rows, to minimize conflict with the concurrent Tutorial PR (Diátaxis: pipeline-crew Tutorial — stand up your first crew (zero → live crew draining the board) #3567) editing the same README.Merge model
Non-control-plane docs PR (crew surfaces are non-§CP by design) — ships on green, no bank.
Fixes #3566