docs: fix rule installation examples#932
Conversation
Clarify that manual rule installation should preserve the rules directory structure so references keep working and filename collisions are avoided.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates to README files (English and Chinese) revising manual rule-installation instructions: replace wildcard/content copying ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Greptile SummaryThis PR fixes the manual rule-installation shell commands in both Key changes:
Confidence Score: 5/5Documentation-only fix with correct shell semantics — safe to merge. All changes are documentation corrections. The new No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["User runs manual install"] --> B{"mkdir -p target rules dir"}
B --> C["cp -r rules/common target/"]
C --> D["cp -r rules/typescript target/\n(or other language)"]
D --> E{"Result:\ntarget/common/\ntarget/typescript/"}
E --> F["Relative refs inside each dir\nstill resolve correctly ✓"]
G["OLD: cp -r rules/common/* target/"] --> H{"Result:\ntarget/agents.md\ntarget/security.md …"}
H --> I["Files mixed into flat dir\nRelative refs broken ✗\nFilename collisions possible ✗"]
Reviews (2): Last reviewed commit: "docs: use directory-level rule copy exam..." | Re-trigger Greptile |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 642-648: Update the FAQ “Just rules” example so it uses
directory-level copies instead of the wildcard path `rules/common/*`: locate the
snippet named “Just rules” that currently references `rules/common/*` and change
it to mirror the other examples by copying the whole directory (e.g., use the
directory `rules/common` rather than `rules/common/*`), and likewise ensure any
language-specific examples follow the directory-level pattern (e.g.,
`rules/typescript`, `rules/python`, etc.) so relative references remain correct.
In `@README.zh-CN.md`:
- Around line 378-384: Update the Option 1 snippet in README.zh-CN.md so it
copies whole rule directories instead of using the wildcard form; replace the
`cp -r everything-claude-code/rules/* ...` approach with explicit `cp -r
everything-claude-code/rules/common ...` and language-specific directory copies
(e.g., `typescript`, `python`, `golang`, `perl`) to match the later “copy full
directories” examples; ensure the Option 1 block mirrors the exact directory
names used in the shown snippet so the Chinese README remains consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
thanks for the PR. quick triage: maintainer review pending. if there are docs, screenshots, or repro steps, please drop them here. |
Clarify that manual rule installation should preserve the rules directory structure so references keep working and filename collisions are avoided.
Summary by CodeRabbit