Skip to content

docs(rules): configure the rules audit per repo for org-wide reuse#131

Merged
zolotokrylin merged 5 commits into
mainfrom
docs/rules-check-config-driven
Jul 17, 2026
Merged

docs(rules): configure the rules audit per repo for org-wide reuse#131
zolotokrylin merged 5 commits into
mainfrom
docs/rules-check-config-driven

Conversation

@zolotokrylin

@zolotokrylin zolotokrylin commented Jul 15, 2026

Copy link
Copy Markdown
Member

Problem

The rules audit hardcoded this repo's layout (id prefix, index path, heading levels, link style, web-app root-README checks), so no other repo could run the same script without forking it.

Solution

Moves every repo-specific setting into rules.config.yml, so scripts/check-rules.mjs is identical in every repo that adopts the standard and only the config differs. Behavior here is unchanged: the audit still passes on 34 rules, and a negative test confirms it still catches missing headings and dashes.

Configurable settings: id prefix, rules dir, index file, filename style (id vs id-slug), title-as-H2, Problem/Solution/Acceptance heading levels, link style (inline vs reference), required frontmatter fields, Problem length cap, and toggles for Acceptance Criteria, no-dashes, lower-id dependencies, docs-spine reachability, and the root-README checks.

Related

Summary by CodeRabbit

  • New Features

    • Added repository-specific configuration for rules auditing.
    • Rules validation now uses the configured identifier prefix and checks matching filenames, references, and links.
    • Documentation reachability checks now recognize both inline and reference-style Markdown links.
  • Documentation

    • Updated guidance in the rules documentation README.

@zolotokrylin zolotokrylin self-assigned this Jul 15, 2026
@holdex

holdex Bot commented Jul 15, 2026

Copy link
Copy Markdown

Time Submission Status

Member # Time Running Total Status Last Update
zolotokrylin 1 11min 11min Jul 15, 2026, 9:14 AM
zolotokrylin 2 7min 7min Jul 17, 2026, 7:30 AM
zolotokrylin 7min ✅ Submitted

Submit or update total time with:

@holdex pr submit-time 2h

Add time on top of previous submission with:

@holdex pr add-time 1h30m

See available commands to help comply with our Guidelines.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@zolotokrylin, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9aef202b-f894-4d61-9ca7-d03d6ee66b74

📥 Commits

Reviewing files that changed from the base of the PR and between 65e5faf and d4fd090.

📒 Files selected for processing (2)
  • rules.config.yml
  • scripts/check-rules.mjs

Walkthrough

The rules audit now reads a repository-specific idPrefix, applies it to rule and link validation, and detects documentation reachability through both inline and reference-style Markdown links.

Changes

Rules audit configuration and validation

Layer / File(s) Summary
Configurable rule prefix validation
rules.config.yml, scripts/check-rules.mjs
The audit reads idPrefix from configuration and uses it for rule selection, frontmatter IDs, rule links, and README indexing.
Expanded documentation reachability
scripts/check-rules.mjs
Spine traversal now extracts targets from inline links and reference-link definitions; the DEV-338 comment wording is also updated.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • holdex/developers#124: Modifies the same rules-audit script and integrates it with push-workflow checks.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/rules-check-config-driven

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@zolotokrylin zolotokrylin left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@holdex pr submit-time 11m

@zolotokrylin zolotokrylin left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@holdex pr submit-time 7m

@zolotokrylin
zolotokrylin marked this pull request as ready for review July 17, 2026 07:29
@zolotokrylin
zolotokrylin merged commit 35c74c8 into main Jul 17, 2026
1 of 2 checks passed
@zolotokrylin
zolotokrylin deleted the docs/rules-check-config-driven branch July 17, 2026 07:30
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.

Problem: repos can't share one rules audit across the org

1 participant