Skip to content

docs: add rules reference page#6

Draft
leno23 wants to merge 1 commit into
depmedicdev-byte:mainfrom
leno23:hermes-auto/ci-doctor-1-rules-reference
Draft

docs: add rules reference page#6
leno23 wants to merge 1 commit into
depmedicdev-byte:mainfrom
leno23:hermes-auto/ci-doctor-1-rules-reference

Conversation

@leno23
Copy link
Copy Markdown

@leno23 leno23 commented May 17, 2026

Summary

  • Add docs/rules.md as the requested rules reference page with all 16 rules.
  • Include severity, category, rationale, bad/good examples, suggested fix text, and source links for each rule.
  • Link the new reference page from the README rules section.

Fixes #1

Test plan

  • Static validation: generated reference contains 16 unique rule sections.
  • Static validation: each section contains source link, bad example, good example, and suggested fix text.
  • Static validation: README now links to docs/rules.md.
  • Not run: runtime test suite, because this is a documentation-only change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add a "rules" reference page that lists every rule with rationale + suggested fix

1 participant