Skip to content

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

@depmedicdev-byte

Description

@depmedicdev-byte

Background

ci-doctor ships 16 rules. The README lists them in a table but the
rationale and suggested fix are scattered.

What we want

A single docs/rules.md that, for each rule:

  • ID (e.g. unpinned-action)
  • Severity (error / warn / info)
  • One-paragraph rationale (why this is a real problem)
  • Bad example (5-line YAML)
  • Good example (5-line YAML)
  • Link back to the source file in src/rules/

The same content can be templated from the existing rule metadata; you
shouldn't need to rewrite the rule modules. A small Node script that
walks src/rules/*.js, reads the exported description /
severity, and renders Markdown is enough.

Acceptance

  • New file docs/rules.md is generated and checked in
  • A script tools/build-rules-doc.mjs regenerates it
  • README links to docs/rules.md
  • npm test still passes

Estimate

~1 hour for someone new to the repo.

This is a great first contribution; happy to review the PR same-day.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions