docs: gm updates based on running a fresh instance

[MSevey]

Overview

Minor edits based on some bugs found during testing on fresh instances.

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• Documentation
  • Updated the tutorial with warning and tip messages about installing the jq tool and troubleshooting the gmd command.

[coderabbitai]

Walkthrough

The update enhances the documentation for a project by providing users with helpful warnings and tips regarding the installation and troubleshooting of the jq command line tool. It specifically addresses the issue of the gmd command not being found, offering clear guidance on how to rectify this problem, ensuring a smoother experience for users setting up their environment.

Changes

File Path	Change Summary
tutorials/.../gm-world.md	Added warnings and tips about jq installation and fixing gmd command not found errors.

🐇✨
In the realm of code, where the bits do hop,
A rabbit came to aid, with a skip and a bop.
"Fear not the jq woes, nor the gmd dread,
For with these tips, you'll move swiftly ahead!"
🌟🐾

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-02-12 17:17 UTC

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 36e794e and 9f5314b.

Files selected for processing (1)

• tutorials/gm-world.md (1 hunks)

Additional comments: 1

tutorials/gm-world.md (1)

• 406-408: The tip for resolving gmd not found errors by adding the go/bin directory to the PATH is helpful. Ensure that this instruction is consistent with the setup steps provided earlier in the document, specifically regarding the installation and use of Go and Ignite CLI tools.

Verification successful

---

The review of the provided script output indicates that while the document mentions installing Golang and Ignite CLI, it does not explicitly include instructions for adding the go/bin directory to the PATH as part of the setup instructions. This suggests that the tip provided in the document about modifying the PATH to resolve gmd not found errors is indeed a helpful addition and is consistent with ensuring a complete setup for users, assuming no other part of the document covers this specific PATH modification step. Based on this evidence, the tip appears to be a necessary complement to the setup instructions provided.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that Go installation steps mention setting PATH correctly
rg --type md 'install Golang|Ignite CLI' tutorials/gm-world.md

Length of output: 1189