Repository navigation
Cycle Packet Markdownlint Gate #36
Copy link
Copy link
Open
Labels
lane:cool-ideasInteresting but not committed work.Interesting but not committed work.legend:processMethod process, workflow, adapters, and CLI work.Method process, workflow, adapters, and CLI work.needs-designNeeds or is missing a Method design artifact.Needs or is missing a Method design artifact.priority:mediumMedium priority.Medium priority.type:maintenanceMaintenance, cleanup, or operational workflow work.Maintenance, cleanup, or operational workflow work.
Description
Activity
- addedlane:cool-ideasInteresting but not committed work.Interesting but not committed work.legend:processMethod process, workflow, adapters, and CLI work.Method process, workflow, adapters, and CLI work.priority:mediumMedium priority.Medium priority.
on Jun 1, 2026 🔗 Related PRs
#2 - Add drift detector command and close out cycle 0005 [merged]
#5 - Shape release workflow and user migration docs [merged]
#6 - Automated Witness Capture (Cycle 0020) [merged]
#18 - Land 0030-0033 repo-truth and MCP debt fixes [merged]
#20 - Add backlog notes for agent-first planning and review workflow [merged]
📝 Issue Planner
Check the box below or use the
@coderabbitai plancommand to generate an implementation plan and prompts that you can use with your favorite coding assistant.- Create Plan
🧪 Issue enrichment is currently in open beta.
You can configure auto-planning by selecting labels in the issue_enrichment configuration.
To disable automatic issue enrichment, add the following to your
.coderabbit.yaml:issue_enrichment: auto_enrich: enabled: false
💬 Have feedback or questions? Drop into our discord!
- addedneeds-designNeeds or is missing a Method design artifact.Needs or is missing a Method design artifact.type:maintenanceMaintenance, cleanup, or operational workflow work.Maintenance, cleanup, or operational workflow work.
on Jun 1, 2026
Metadata
Metadata
Assignees
Labels
lane:cool-ideasInteresting but not committed work.Interesting but not committed work.legend:processMethod process, workflow, adapters, and CLI work.Method process, workflow, adapters, and CLI work.needs-designNeeds or is missing a Method design artifact.Needs or is missing a Method design artifact.priority:mediumMedium priority.Medium priority.type:maintenanceMaintenance, cleanup, or operational workflow work.Maintenance, cleanup, or operational workflow work.
Migrated from Method backlog
This issue was created from a legacy filesystem backlog card. GitHub Issues are now the live work tracker; repository docs remain Method evidence.
Source backlog:
docs/method/backlog/cool-ideas/PROCESS_cycle-packet-markdownlint-gate.mdOriginal lane:
cool-ideasOriginal legend:
PROCESSOriginal priority:
mediumOriginal backlog card
Cycle Packet Markdownlint Gate
This review round caught witness and retro packet issues that a small
markdown lint pass could have surfaced before PR review: unlabeled code
fences, empty placeholder blocks, and wording drift inside committed
artifacts.
Idea: add a bounded markdown validation step for cycle packets and other
generated repo artifacts so contract-level doc issues fail fast instead
of landing as manual review cleanup.
Proposed Contract
Prerequisites
PROCESS_validate-command.mddefines the parentmethod validatesurface. This item assumes that contract lands first or in the same
slice.
Scope globs:
markdown rules cover
docs/design/[0-9][0-9][0-9][0-9]-*/**/*.mdanddocs/method/retro/[0-9][0-9][0-9][0-9]-*/**/*.md.Rules:
MD040(fenced code blocks need a language),MD031(fenced code blocks need surrounding blank lines), and custompacket checks for required frontmatter keys on generated docs.
Frontmatter checks:
design docs require
title,legend,cycle, andsource_backlog;top-level retro docs at
docs/method/retro/[0-9][0-9][0-9][0-9]-*/*.mdrequiretitle,cycle,design_doc,outcome, anddrift_check; witnessartifacts under
**/witness/**/*.mdare linted for markdown rulesonly unless they later get their own explicit frontmatter contract.
Integration point:
this item depends on
PROCESS_validate-command.md. The intendedsurface is
method validate markdownas a subcommand of the parentmethod validateCLI implemented insrc/cli.ts, not a separatetop-level verb. Implementers should either land both contracts in the
same slice or wire this markdown gate into the existing
validatecommand surface before invoking it locally, from pre-commit, or from
a CI job such as
markdown-contract.Pass / fail behavior:
exit
0when all scoped files satisfy the bounded rule set; exitnon-zero when any scoped file violates one of the named rules or
frontmatter checks, with output that names the file and failing rule.
Non-goals
checks.