Enhance installation instructions for Wails - #5834
Conversation
Updated installation instructions for Wails to include new commands for updating PATH in different shell environments.
github-actions
Bot
added
the
Documentation
WalkthroughThe Linux installation guide replaces combined Bash/Zsh PATH instructions with an MDX Tabs section containing separate Bash, Zsh, and Fish commands. ChangesInstallation documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@website/versioned_docs/version-v2.13.0/gettingstarted/installation.mdx`:
- Around line 76-84: Update the bash and zsh TabItem command blocks to remove
the “bash:” and “zsh:” prefixes, leaving only the executable source commands so
they can be copied and run directly.
- Around line 86-87: Update the Fish installation command in the fish TabItem to
derive the Go binary directory from `go env GOPATH`, matching the Bash and Zsh
instructions, so custom GOPATH configurations resolve the correct path.
🪄 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: CHILL
Plan: Pro Plus
Run ID: 9b951afc-aa60-40a4-8296-d9bc2f8d7cda
📒 Files selected for processing (1)
website/versioned_docs/version-v2.13.0/gettingstarted/installation.mdx
| <TabItem value="bash"> | ||
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | ||
| <br/> | ||
| <code>source ~/.bashrc</code> or <code>source ~/.zshrc</code> | ||
| <code>bash: source ~/.bashrc</code> | ||
| </TabItem> | ||
| <TabItem value="zsh"> | ||
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | ||
| <br/> | ||
| <code>zsh: source ~/.zshrc</code> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Remove the bash: and zsh: prefixes from the commands.
Lines 79 and 84 currently render bash: source ~/.bashrc and zsh: source ~/.zshrc; copying either line literally will fail because bash:/zsh: is interpreted as the command name.
Proposed fix
- <code>bash: source ~/.bashrc</code>
+ <code>source ~/.bashrc</code>
...
- <code>zsh: source ~/.zshrc</code>
+ <code>source ~/.zshrc</code>📝 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.
| <TabItem value="bash"> | |
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | |
| <br/> | |
| <code>source ~/.bashrc</code> or <code>source ~/.zshrc</code> | |
| <code>bash: source ~/.bashrc</code> | |
| </TabItem> | |
| <TabItem value="zsh"> | |
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | |
| <br/> | |
| <code>zsh: source ~/.zshrc</code> | |
| <TabItem value="bash"> | |
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | |
| <br/> | |
| <code>source ~/.bashrc</code> | |
| </TabItem> | |
| <TabItem value="zsh"> | |
| <code>export PATH=$PATH:$(go env GOPATH)/bin</code> | |
| <br/> | |
| <code>source ~/.zshrc</code> |
🤖 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 `@website/versioned_docs/version-v2.13.0/gettingstarted/installation.mdx`
around lines 76 - 84, Update the bash and zsh TabItem command blocks to remove
the “bash:” and “zsh:” prefixes, leaving only the executable source commands so
they can be copied and run directly.
| <TabItem value="fish"> | ||
| <code>fish_add_path ~/go/bin</code> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Derive Fish’s path from GOPATH as well.
fish_add_path ~/go/bin only works with the default GOPATH, whereas the Bash and Zsh commands use go env GOPATH. Users with a custom GOPATH will add the wrong directory and may still see wails: command not found.
- <code>fish_add_path ~/go/bin</code>
+ <code>fish_add_path (go env GOPATH)/bin</code>📝 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.
| <TabItem value="fish"> | |
| <code>fish_add_path ~/go/bin</code> | |
| <TabItem value="fish"> | |
| <code>fish_add_path (go env GOPATH)/bin</code> |
🤖 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 `@website/versioned_docs/version-v2.13.0/gettingstarted/installation.mdx`
around lines 86 - 87, Update the Fish installation command in the fish TabItem
to derive the Go binary directory from `go env GOPATH`, matching the Bash and
Zsh instructions, so custom GOPATH configurations resolve the correct path.
1 participant
Updated installation instructions for Wails to include new commands for updating PATH in different shell environments.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please select the option that is relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using
wails doctor.If you checked Linux, please specify the distro and version.
Test Configuration
Please paste the output of
wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.Checklist:
website/src/pages/changelog.mdxwith details of this PR (v3 changelog entries are added automatically)Summary by CodeRabbit
fish_add_path.