docs(prep): rewrite examples README around real YAML-sidecar pipeline#102
Merged
Conversation
Original README told contributors to edit docs/cli/<area>/*.md by hand. Those files are auto-generated by pnpm docs:gen from YAML sidecars; hand-edits get clobbered and break pnpm docs:check in CI. Rewrites the README to document the actual flow (sidecars + allowlist + docs:gen + docs:check) and explains the only legitimate path for blocked commands (keep entry on .missing-allowlist with a tracking-issue comment).
This was referenced May 25, 2026
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
1 participant
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.
The original PREP README (#97) told contributors to edit
docs/cli/<area>/*.mdby hand. Those files are auto-generated bypnpm docs:genfrom the YAML sidecars; hand-edits get overwritten by the next generation and breakpnpm docs:checkin CI. PR #100 hit this exact problem.This PR rewrites the README to document the real flow:
docs/cli/examples/<area>.yaml(keyed by full command path).missing-allowlistas examples land!!! bugadmonition path)pnpm docs:genregenerates the .md;pnpm docs:checkvalidates drift + missing examples in CIUnblocks waves 2–5 of epic #83.