-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
Summary
Add a CI check that uses Claude to enforce our documentation philosophy:
README.md → docs/ → specs/ → tests/
Behavior
- Trigger: Every PR
- On failure: Fail the build (block merge)
What to Verify
- Features documented in README have corresponding entries in
docs/ - Docs reference specs that define the behavior
- Specs have corresponding e2e tests that verify the behavior
- Tests match what specs describe
Implementation Ideas
- Use Claude in a GitHub Action to analyze PR changes
- Check for documentation completeness across the chain
- Provide actionable feedback when docs are missing or out-of-sync
- Could use Claude Code CLI or Anthropic API directly
Acceptance Criteria
- CI runs on every PR
- Fails with clear message when documentation chain is broken
- Suggests what documentation needs to be added/updated
Metadata
Metadata
Assignees
Labels
No labels