Skip to content

docs: update docs and templates for category reclassification#84

Merged
let-sunny merged 2 commits intomainfrom
chore/update-docs-v2
Mar 25, 2026
Merged

docs: update docs and templates for category reclassification#84
let-sunny merged 2 commits intomainfrom
chore/update-docs-v2

Conversation

@let-sunny
Copy link
Copy Markdown
Owner

@let-sunny let-sunny commented Mar 25, 2026

Summary

  • Update category names (6→5): structure, token, component, naming, behavior
  • Update rule tables with new/merged rule IDs and correct scores
  • Fix coderabbit.yaml pre_merge_checks schema
  • Update agent prompts with new categories
  • Update issue template and fixture feedback docs

Clean rebase of #83 after #81 was merged to main.

Refs #79

Test plan

  • Docs-only changes, no code affected
  • All score/severity values verified against rule-config.ts

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated rule taxonomy with simplified category structure: replaced separate "Layout" and "AI Readability/Handoff Risk" categories with unified "Structure" and "Behavior" categories, reducing from 6 to 5 total categories.
    • Revised scoring model to reflect the new 5-category framework with equal weighting across categories.
    • Updated reference documentation with revised rule listings and examples.
  • Chores

    • Updated code review configuration settings.

…fication

- Update category names (6→5): structure, token, component, naming, behavior
- Update rule tables with new/merged rule IDs and correct scores
- Fix coderabbit.yaml pre_merge_checks schema (docstrings.mode: off)
- Update agent prompts (converter, designer) with new categories
- Update issue template and fixture feedback docs

Refs #79

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c380a1c7-d682-42fc-b150-4a670decc757

📥 Commits

Reviewing files that changed from the base of the PR and between 0abe6b1 and 91e0a2e.

📒 Files selected for processing (9)
  • .claude/agents/calibration/converter.md
  • .claude/agents/rule-discovery/designer.md
  • .coderabbit.yaml
  • .github/ISSUE_TEMPLATE/bug.yml
  • docs/CALIBRATION.md
  • docs/MCP-VS-CLI.md
  • docs/REFERENCE.md
  • docs/SCORING.md
  • docs/fixtures/ANALYSIS-VALIDITY-FEEDBACK.md

📝 Walkthrough

Walkthrough

This pull request updates the design rule taxonomy documentation and configuration across the codebase. The category structure is refactored from six categories (layout, token, component, naming, ai-readability, handoff-risk) to five (structure, token, component, naming, behavior). Associated rules are reclassified and documented accordingly.

Changes

Cohort / File(s) Summary
Rule Taxonomy Schema Updates
.claude/agents/calibration/converter.md, .claude/agents/rule-discovery/designer.md, docs/REFERENCE.md
Updated allowed category enum values from layout | token | component | naming | ai-readability | handoff-risk to structure | token | component | naming | behavior. Schema guidance and examples adjusted to reflect new taxonomy.
Documentation & Reference
docs/CALIBRATION.md, docs/SCORING.md, docs/MCP-VS-CLI.md
Updated conceptual documentation with new category names and rule classifications. Scoring model recalculated as average of 5 categories instead of 6. Comparison examples reclassified with new rule IDs and categories.
Rule Catalog & Guidance
docs/REFERENCE.md, docs/fixtures/ANALYSIS-VALIDITY-FEEDBACK.md
Updated rule listings, removing fixed-width-in-responsive-context, missing-min-width, missing-max-width from structure; reclassifying invisible-layer to unnecessary-node; adding new structure and behavior rules. Fixture validity guidance updated to reference unnecessary-node instead of invisible-layer.
Configuration & Templates
.coderabbit.yaml, .github/ISSUE_TEMPLATE/bug.yml
Changed docstring coverage check configuration from enabled: false to docstrings.mode: "off". Updated bug template placeholders to reference unnecessary-node and src/core/rules/structure/ instead of former invisible-layer and ai-readability paths.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 The rules now dance in five-part grace,
Structure blooms where layout once had place,
Behavior takes the handoff's old refrain,
Categories simplified, clarity gained!
Hops of joy for taxonomy made plain! 🎉

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately summarizes the main change: updating documentation and templates to reflect the category reclassification from 6 to 5 categories.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-docs-v2

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

@let-sunny let-sunny marked this pull request as ready for review March 25, 2026 20:52
@let-sunny let-sunny merged commit fd664de into main Mar 25, 2026
3 checks passed
@let-sunny let-sunny deleted the chore/update-docs-v2 branch March 25, 2026 21:14
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