-
Notifications
You must be signed in to change notification settings - Fork 37
docs: fix broken link #140
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThe change updates the README to modify the URL for the NEAR CLI setup instructions in the prerequisites section. The new link directs users to a general help page instead of the Rust-specific CLI documentation. No other content or code was altered. Changes
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -147,7 +147,7 @@ scripts/enrich.sh | |||
Rust, go, cmake, and friends should be installed. For a list of required installation items, please look at `flake.nix#nativeBuildInputs`. | |||
If you use Nix, you're in luck! Just do `direnv allow`, and you're good to go. | |||
|
|||
[Ensure you have setup](https://docs.near.org/tools/near-cli-rs) `near-cli`. | |||
[Ensure you have setup](https://docs.near.org/help#-cli) `near-cli`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Nit: fix grammar and link text.
Use the verb phrase "set up" instead of the noun "setup", and embed the CLI name in the link text for clarity.
- [Ensure you have setup](https://docs.near.org/help#-cli) `near-cli`.
+ [Ensure you have set up `near-cli`](https://docs.near.org/help#-cli).
📝 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.
[Ensure you have setup](https://docs.near.org/help#-cli) `near-cli`. | |
[Ensure you have set up `near-cli`](https://docs.near.org/help#-cli). |
🤖 Prompt for AI Agents
In README.md at line 150, replace the phrase "Ensure you have setup" with
"Ensure you have set up" to use the correct verb form, and update the link text
to explicitly include "near-cli" for clarity, such as "Ensure you have set up
near-cli".
This change is
Summary by CodeRabbit