Repository navigation
Conversation
- Added a clarifying comment for PATH export command - Rewrote section title, to clearly stated what the commands needed for I thought a section about modifying PATH env to make Go globally accessible sounded a bit misleading. The section doesn't clearly point out that the command `export PATH` should be added to bashrc or zshrc, and should not be executed in terminal session (since persistence is desired). This confusion is created because the section's block combines both command for env modify and reload in one block without much emphasis on where the commands should go to.
WalkthroughThis PR updates the Linux installation documentation to clarify environmental variable configuration. The instruction heading was renamed from "Add to PATH" to "Modify environmental variables to make Go globally accessible," and an inline comment was added to explain PATH persistence through shell configuration files. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 the current code and only fix it if needed.
Inline comments:
In `@docs/src/content/docs/quick-start/installation.mdx`:
- Line 90: The heading text contains typos: replace "Modify enviromental
variables to make Go globally accessable" with corrected wording such as "Modify
environment variables to make Go globally accessible" (use "environment
variables" and "accessible"); update the heading in the
docs/quick-start/installation.mdx where that exact heading string appears.
- Around line 92-93: The reload step currently always sources ~/.bashrc while
the preceding export instruction mentions both ~/.bashrc and ~/.zshrc; change
the reload instruction so it matches the edited shell config: either split into
two blocks (one showing the export and source for ~/.bashrc and one for
~/.zshrc) or replace the single "source ~/.bashrc" line with a shell-agnostic
statement that sources the correct file (e.g., conditional on $SHELL or an
instruction like "source ~/.bashrc or source ~/.zshrc") so the "export PATH=..."
line and the corresponding reload command stay consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 28336c0e-3558-4987-b59f-247c8a612e41
📒 Files selected for processing (1)
docs/src/content/docs/quick-start/installation.mdx
| ``` | ||
|
|
||
| **Add to PATH** (add to `~/.bashrc` or `~/.zshrc`): | ||
| **Modify enviromental variables to make Go globally accessable**: |
There was a problem hiding this comment.
Fix the new heading typos.
Line 90 introduces two spelling errors: enviromental and accessable. I’d also prefer environment variables over environmental variables here.
Suggested wording
- **Modify enviromental variables to make Go globally accessable**:
+ **Modify environment variables to make Go globally accessible**:📝 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.
| **Modify enviromental variables to make Go globally accessable**: | |
| **Modify environment variables to make Go globally accessible**: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/src/content/docs/quick-start/installation.mdx` at line 90, The heading
text contains typos: replace "Modify enviromental variables to make Go globally
accessable" with corrected wording such as "Modify environment variables to make
Go globally accessible" (use "environment variables" and "accessible"); update
the heading in the docs/quick-start/installation.mdx where that exact heading
string appears.
| export PATH=$PATH:/usr/local/go/bin:~/go/bin # Append to the end of ~/.bashrc or ~/.zshrc for persistence. | ||
| source ~/.bashrc # Reload |
There was a problem hiding this comment.
Make the reload step match the shell file users actually edited.
Line 92 says to persist the export in either ~/.bashrc or ~/.zshrc, but Line 93 always reloads ~/.bashrc. That will mislead zsh users and still makes the two actions look like one terminal-only sequence. Please either split this into separate “add this to your shell config” and “reload that file” blocks, or at least make the reload line shell-agnostic.
Suggested doc tweak
- export PATH=$PATH:/usr/local/go/bin:~/go/bin # Append to the end of ~/.bashrc or ~/.zshrc for persistence.
- source ~/.bashrc # Reload
+ export PATH=$PATH:/usr/local/go/bin:~/go/bin # Add this to ~/.bashrc or ~/.zshrc for persistence
+ source ~/.bashrc # or: source ~/.zshrc📝 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.
| export PATH=$PATH:/usr/local/go/bin:~/go/bin # Append to the end of ~/.bashrc or ~/.zshrc for persistence. | |
| source ~/.bashrc # Reload | |
| export PATH=$PATH:/usr/local/go/bin:~/go/bin # Add this to ~/.bashrc or ~/.zshrc for persistence | |
| source ~/.bashrc # or: source ~/.zshrc |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/src/content/docs/quick-start/installation.mdx` around lines 92 - 93, The
reload step currently always sources ~/.bashrc while the preceding export
instruction mentions both ~/.bashrc and ~/.zshrc; change the reload instruction
so it matches the edited shell config: either split into two blocks (one showing
the export and source for ~/.bashrc and one for ~/.zshrc) or replace the single
"source ~/.bashrc" line with a shell-agnostic statement that sources the correct
file (e.g., conditional on $SHELL or an instruction like "source ~/.bashrc or
source ~/.zshrc") so the "export PATH=..." line and the corresponding reload
command stay consistent.
ghost
changed the title
ghost
closed this
Description
I thought a section about modifying PATH env to make Go globally accessible sounded a bit misleading. The section doesn't clearly point out that the command
export PATHshould be added to bashrc or zshrc, and should not be executed in terminal session (since persistence is desired). This confusion is created because the section's block combines both command for env modify and reload in one block without much emphasis on where the commands should go to.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.