Skip to content

docs: clarify Bun setup without duplicate steps#350

Merged
claude-code-best merged 3 commits intoclaude-code-best:mainfrom
YuanyuanMa03:fix-bun-install-readme
Apr 24, 2026
Merged

docs: clarify Bun setup without duplicate steps#350
claude-code-best merged 3 commits intoclaude-code-best:mainfrom
YuanyuanMa03:fix-bun-install-readme

Conversation

@YuanyuanMa03
Copy link
Copy Markdown
Contributor

@YuanyuanMa03 YuanyuanMa03 commented Apr 24, 2026

Summary

  • clarify Bun post-install steps without duplicating the installer output
  • explain where to run Bun setup/check commands versus project commands
  • keep README.md and README_EN.md aligned

Test Plan

  • docs-only change
  • verified PR diff only includes README.md and README_EN.md

Summary by CodeRabbit

  • Documentation
    • Improved Bun installation instructions with clearer PATH configuration guidance for different shells (zsh, bash, PowerShell).
    • Added clarification on command execution locations: installation and build steps require the repository root containing package.json, while general Bun commands work from any directory.
    • Enhanced installation verification steps.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ffbbd659-91b3-422f-af1f-11d5121e89df

📥 Commits

Reviewing files that changed from the base of the PR and between d09f363 and 017c251.

📒 Files selected for processing (2)
  • README.md
  • README_EN.md

📝 Walkthrough

Walkthrough

Documentation updates to Bun installation instructions in both Chinese and English READMEs, including PATH configuration clarifications, shell-specific reload commands, enhanced verification steps, and a new section detailing where commands can be executed.

Changes

Cohort / File(s) Summary
Bun Installation Documentation
README.md, README_EN.md
Restructured post-installation steps with shell-specific PATH reloading instructions (zsh exec /bin/zsh, bash source ~/.bashrc, PowerShell restart). Enhanced verification to include both bun --help and bun --version. Added new section clarifying command execution locations and updated dependency installation example with cd into repository root.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • docs: 添加 Bun 安装详细说明 #341 — Related modifications to Bun installation instructions in README and README_EN files with similar structural updates to post-install steps and verification guidance.

Poem

🐰 Documentation hops with care,
Bun's path now crystal clear,
Shell commands reload with flair,
Instructions now sincere! ✨

🚥 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 PR title accurately describes the main change: clarifying Bun setup instructions while removing duplicate steps in the README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@claude-code-best claude-code-best merged commit 8613d55 into claude-code-best:main Apr 24, 2026
3 checks passed
@YuanyuanMa03 YuanyuanMa03 deleted the fix-bun-install-readme branch April 24, 2026 11:56
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.

2 participants