Clarify gh CLI shortcut on homepage, bump Bun version requirement to >=1.4 - #212
Merged
Merged
Conversation
Contributor
|
Coverage after merging docs/homepage-gh-cli-and-bun-version into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- InstallSection.vue: add a hint to step 2 noting the export-token step can be skipped entirely when the GitHub CLI is installed and authenticated (gh auth token is used automatically). - CONTRIBUTING.md, docs/getting-started/index.md, installation.md: bump the documented Bun requirement from >=1.0 to >=1.4, matching README.md and AGENTS.md — native Bun 1.4+ APIs (stringWidth/stripANSI/sliceAnsi, styleText) are used throughout the codebase.
shouze
force-pushed
the
docs/homepage-gh-cli-and-bun-version
branch
from
September 19, 2026 11:51
0dd8be0 to
17162dd
Compare
Contributor
|
Coverage after merging docs/homepage-gh-cli-and-bun-version into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The advertised token fallback is not implemented, and the external link needs an accessible new-tab indication.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
What changed in this PR
This PR updates onboarding documentation for Bun ≥1.4 and adds GitHub CLI token guidance to the homepage.
Changes:
- Updates Bun requirements in contributor and getting-started documentation.
- Adds a GitHub CLI token shortcut hint.
- Requires fixes for the unsupported
gh auth tokenfallback and missing new-tab accessibility label.
| File | Summary |
|---|---|
docs/getting-started/installation.md |
Updates Bun requirement. |
docs/getting-started/index.md |
Updates Bun requirement. |
docs/.vitepress/theme/InstallSection.vue |
Adds GitHub CLI guidance; contains one moderate issue and one nit. |
CONTRIBUTING.md |
Updates Bun prerequisite. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
🔦 Lighthouse Report
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
docs/.vitepress/theme/InstallSection.vue): step 2 ("Export your GitHub token") now includes a hint that this step can be skipped entirely if the GitHub CLI is already installed and authenticated —github-code-searchretrieves a token automatically viagh auth token.>= 1.0to>= 1.4inCONTRIBUTING.md,docs/getting-started/index.mdanddocs/getting-started/installation.md, matching whatREADME.md/AGENTS.mdalready state — the codebase uses native Bun 1.4+ APIs (Bun.stringWidth/stripANSI/sliceAnsi,node:util'sstyleText).How did you verify your code works?
vitepress preview(both hint boxes render correctly, consistent styling).bun test(1016 passing),bun run lint,bun run format:check,bun run knip,bun run build.tsall green.bun run docs:buildsucceeds.