docs: add shell helper

[jcstein]

Overview

Summary by CodeRabbit

• Documentation
  • Added a new tip in the Go installation process to help users identify their shell type for better troubleshooting.
  • Renumbered the steps in the installation guide for improved clarity.

[coderabbitai]

Walkthrough

The recent update enhances the Go installation documentation by adding a tip for users to check their shell type with the command echo $SHELL before verifying the installation. This practical guidance aims to improve user troubleshooting and environment setup confirmation. Additionally, the step numbering has been adjusted to accommodate this new tip, ensuring a clearer and more user-friendly documentation structure.

Changes

File Path	Change Summary
nodes/environment.md	Added a tip for users to check their shell type using echo $SHELL before verifying Go installation; renumbered original steps accordingly.

Poem

In the garden of code, where bunnies hop,
A tip for the shells, we’re bound to drop.
With echo they'll see, the type that they wield,
Making Go installations much easier to field! 🐇✨
So follow the guide, and hop with delight,
For every good coder, the future is bright!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1660/
on branch main at 2024-08-08 15:16 UTC

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 86fb976 and 6134cd6.

Files selected for processing (1)

• nodes/environment.md (1 hunks)

Additional context used

LanguageTool

nodes/environment.md

[uncategorized] ~144-~144: Possible missing comma found.
Context: ...the correct version of Go was installed correctly run: bash go version ...

(AI_HYDRA_LEO_MISSING_COMMA)

Additional comments not posted (2)

nodes/environment.md (2)

140-142: LGTM! The added tip is useful.

The tip to use echo $SHELL helps users identify their shell type, which is important for setting environment variables correctly.

---

144-144: Verify the step renumbering and address the missing comma.

The step renumbering is consistent. However, there is a possible missing comma in the sentence "To verify that the correct version of Go was installed correctly run:". Adding a comma after "correctly" improves readability.

- To verify that the correct version of Go was installed correctly run:
+ To verify that the correct version of Go was installed correctly, run:

Tools

LanguageTool

[uncategorized] ~144-~144: Possible missing comma found.
Context: ...the correct version of Go was installed correctly run: bash go version ...

(AI_HYDRA_LEO_MISSING_COMMA)

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6134cd6 and 981c98e.

Files selected for processing (1)

• nodes/environment.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• nodes/environment.md