Skip to content

Fix CPU requirements link - #31622

Closed
Showfom wants to merge 1 commit into
oven-sh:mainfrom
Showfom:patch-2
Closed

Fix CPU requirements link#31622
Showfom wants to merge 1 commit into
oven-sh:mainfrom
Showfom:patch-2

Conversation

@Showfom

@Showfom Showfom commented May 31, 2026

Copy link
Copy Markdown

What does this PR do?

Fix CPU requirements link

How did you verify your code works?

Just a simple markdown link replacement

Fix CPU requirements link

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

README.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.

Changes

Documentation

Layer / File(s) Summary
x64 users CPU requirements link
README.md
Installation note for x64 users is updated to include a link to Bun's CPU requirements and baseline builds documentation page.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix CPU requirements link' directly matches the main change: updating a CPU requirements link in README.md from plain-text/URL form to a proper Markdown link.
Description check ✅ Passed The PR description includes both required template sections with relevant content: explains the change (link replacement) and verification method (simple markdown link replacement).
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.


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 61bd997 and f3a25c1.

📒 Files selected for processing (1)
  • README.md

Comment thread 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))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

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.

Suggested change
> **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.

@robobun

robobun commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Thanks! This is already being fixed in #29108, so closing this one as a duplicate. (For reference, the change here also ended up nesting the old URL inside the new link's parentheses, so it would not have rendered as a plain link; #29108 swaps the anchor directly.)

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