Fix CPU requirements link - #31622
Conversation
Fix CPU requirements link
WalkthroughREADME.md line 50 updates the installation notice for x64 users to link to Bun's CPU requirements documentation page, replacing the prior unlinked reference. This is a documentation-only change with minimal scope. ChangesDocumentation
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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`:
- Line 50: The Markdown link on the x64 note is malformed due to nested brackets
around the URL; replace the current text with a proper Markdown link by using a
label and a single parenthesized URL, e.g., change the fragment containing
"**x64 users** — if you see "illegal instruction" or similar errors, check our
[CPU requirements]([https://...])" to use the correct syntax "[CPU
requirements](https://bun.com/docs/installation#cpu-requirements-and-baseline-builds)"
so the hyperlink renders correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1522421d-6396-4627-aaa7-b814685af53f
📒 Files selected for processing (1)
README.md
| > **Linux users** — Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. | ||
|
|
||
| > **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements](https://bun.com/docs/installation#cpu-requirements-and-baseline-builds) | ||
| > **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements]([https://bun.com/docs/installation#cpu-requirements-and-baseline-builds](https://bun.com/docs/installation#cpu-requirements)) |
There was a problem hiding this comment.
Fix malformed Markdown link syntax.
The link has nested brackets and parentheses which creates invalid Markdown syntax. The current syntax will not render as a working hyperlink, preventing x64 users from accessing CPU requirements documentation when troubleshooting "illegal instruction" errors.
🔗 Proposed fix
-> **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements]([https://bun.com/docs/installation#cpu-requirements-and-baseline-builds](https://bun.com/docs/installation#cpu-requirements))
+> **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements](https://bun.com/docs/installation#cpu-requirements)📝 Committable suggestion
‼️ 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.
| > **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements]([https://bun.com/docs/installation#cpu-requirements-and-baseline-builds](https://bun.com/docs/installation#cpu-requirements)) | |
| > **x64 users** — if you see "illegal instruction" or similar errors, check our [CPU requirements](https://bun.com/docs/installation#cpu-requirements) |
🤖 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` at line 50, The Markdown link on the x64 note is malformed due to
nested brackets around the URL; replace the current text with a proper Markdown
link by using a label and a single parenthesized URL, e.g., change the fragment
containing "**x64 users** — if you see "illegal instruction" or similar errors,
check our [CPU requirements]([https://...])" to use the correct syntax "[CPU
requirements](https://bun.com/docs/installation#cpu-requirements-and-baseline-builds)"
so the hyperlink renders correctly.
What does this PR do?
Fix CPU requirements link
How did you verify your code works?
Just a simple markdown link replacement