Skip to content

Chore/refresh sample output - #2

Merged
shenxianpeng merged 2 commits into
mainfrom
chore/refresh-sample-output
Aug 4, 2026
Merged

Chore/refresh sample output#2
shenxianpeng merged 2 commits into
mainfrom
chore/refresh-sample-output

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 4, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Added release notes covering new diagnostic rule IDs, JSON metadata, terminal links, expanded branch types, author-pattern configuration, and improved installation and validation behavior.
    • Updated documentation examples to use the correct subject-imperative rule identifier.
    • Added links to the rules reference and unified documentation resources.
  • Tests

    • Added checks to ensure documentation examples match current rule names.

The pasted terminal transcripts still named rules by their config key —
subject_imperative, ai_attribution — but the tool moved to the kebab-case
form the reference headings use. Six samples across four pages, and every
existing test passed, because the heading and options-table guards read
reference tables rather than transcripts.

Adds the missing guard: any CCxxx line in any page must name the rule the
way the installed package prints it. Reverting one sample makes it fail
with the page, the rule and both spellings named.
The changelog stopped at v2.11.0 while v2.12.0, v2.12.1 and v2.12.2 shipped,
so three releases and a user-facing feature — configurable author name and
email patterns — were absent from the site.

Adds those three, and drafts v2.13.0 from the twelve commits on main: stable
rule IDs, the wider default branch types, the linked rule IDs in terminal
output, and the move to this domain. The v2.13.0 date is today's and needs
matching to the actual release.
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ef554790-d0b5-4e3a-96d0-015042d1f141

📥 Commits

Reviewing files that changed from the base of the PR and between cf1caae and 188893e.

📒 Files selected for processing (6)
  • docs/changelog.md
  • docs/guides/ai-attribution.md
  • docs/index.md
  • docs/rules.md
  • docs/what-is-new.md
  • tests/docs_sync_test.py

📝 Walkthrough

Walkthrough

The change adds release notes, updates documented rule-name examples, and adds a test that checks Markdown failure samples against the current rule definitions.

Changes

Documentation and validation

Layer / File(s) Summary
Release notes and historical changes
docs/changelog.md, docs/what-is-new.md
Release notes cover versions 2.13.0 through 2.12.0 and describe rule IDs, output metadata, branch types, author patterns, and other documented behavior changes.
Rule-name example alignment
docs/index.md, docs/rules.md, docs/guides/ai-attribution.md
CC003 examples use subject-imperative. The CC013 example remains unchanged.
Documentation sample validation
tests/docs_sync_test.py
The test extracts rule IDs and printed names from Markdown failure samples and compares them with ALL_RULES.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the documentation sample-output updates and related synchronization test.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/refresh-sample-output

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.

@shenxianpeng
shenxianpeng merged commit 7ddc2b7 into main Aug 4, 2026
4 checks passed
@shenxianpeng
shenxianpeng deleted the chore/refresh-sample-output branch August 4, 2026 10:39
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.

1 participant