Repository navigation
docs: improve README - #10
webbrain-one wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughREADME.md now shows how to preview installation paths and actions with ChangesInstallation documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 34-39: Update the “预览安装路径与动作(Dry Run)” section near the existing
dry-run command to document that when the target directory already exists, users
must also pass --force to preview overwrite actions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ### 预览安装路径与动作(Dry Run) | ||
|
|
||
| ```bash | ||
| npx @anxforever/stylekit-skill install --tool codex --dry-run | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the existing-target behavior.
If the target already exists, install --dry-run still fails unless --force is also provided. Add this condition to the README so users can preview overwrite actions correctly.
Suggested documentation update
### 预览安装路径与动作(Dry Run)
```bash
npx `@anxforever/stylekit-skill` install --tool codex --dry-run+如果目标目录已存在,请同时加上 --force 以预览覆盖动作。
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
### 预览安装路径与动作(Dry Run)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 34 - 39, Update the “预览安装路径与动作(Dry Run)” section near
the existing dry-run command to document that when the target directory already
exists, users must also pass --force to preview overwrite actions.
Makes one small, focused improvement to the existing README.
Summary by CodeRabbit