Skip to content

Commit cb0bbac

Browse files
akoclaude
andcommitted
docs: add documentation section to PR review checklist
Cover skills, CLI help, syntax reference, MDL examples, and site docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ea823c1 commit cb0bbac

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CLAUDE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,13 @@ New MDL commands or language features must be wired through the full pipeline:
259259
- [ ] Independent features (e.g., a new command, a formatter, UX improvements) go in separate PRs even if developed together
260260
- [ ] Refactors that touch many files (e.g., renaming a helper across executors) are their own commit, not bundled with feature work
261261

262+
### Documentation
263+
- [ ] **Skills** — new features documented in `.claude/skills/` (syntax, examples, gotchas)
264+
- [ ] **CLI help**`mxcli` command help text updated (Cobra `Short`/`Long`/`Example` fields)
265+
- [ ] **Syntax reference**`docs/01-project/MDL_QUICK_REFERENCE.md` updated with new statement syntax
266+
- [ ] **MDL examples** — working examples added to `mdl-examples/` for new commands
267+
- [ ] **Site docs**`docs-site/src/` pages added or updated for user-facing features
268+
262269
### Code quality
263270
- [ ] Refactors are applied consistently across all relevant files (grep for the old pattern)
264271
- [ ] Manually maintained lists (keyword lists, type mappings) are flagged as maintenance risks

0 commit comments

Comments
 (0)