docs: slim README and move reference content to docs/#627
Open
fain182 wants to merge 1 commit into
Open
Conversation
README trimmed from 686 to ~80 lines — now covers only hero, quick start, core concepts, a rules index, and links to further reading. Full rule catalog (rules.md) and all configuration / CLI / command reference (configuration.md) extracted to docs/ so they are searchable and versioned without cluttering the landing page. Closes #626 (partial — new content for cookbook, custom-rules, and tool comparison deferred to a follow-up PR). Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #627 +/- ##
=========================================
Coverage 98.25% 98.25%
Complexity 700 700
=========================================
Files 87 87
Lines 2000 2000
=========================================
Hits 1965 1965
Misses 35 35 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/rules.mdinit,debug:expression), baseline, output formats, and Phar usage unified intodocs/configuration.md(previously scattered across three separate README sections)Partial fix for #626 — new content (cookbook, custom-rules, tool comparison) is deferred to a follow-up PR.
Test plan
docs/)docs/rules.md— all rule examples are present and correctdocs/configuration.md— all CLI options match the reference table; commands and baseline sections are accurate🤖 Generated with Claude Code
Generated by Claude Code