-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
docs: fix autocli for non module commands example code link #23407
Conversation
📝 WalkthroughWalkthroughThe pull request updates the Changes
Suggested labels
Suggested reviewers
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
Documentation and Community
|
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.
Actionable comments posted: 0
🧹 Nitpick comments (3)
client/v2/README.md (3)
255-255
: Fix heading hierarchy in Off-Chain section.The "Off-Chain" section should be a level 2 heading (##) to maintain consistent hierarchy with the "AutoCLI" section.
-# Off-Chain +## Off-Chain
255-255
: Add language identifier to code block.The code block should specify the language for proper syntax highlighting.
-``` +```go
255-255
: Standardize on American English spelling.For consistency with the rest of the documentation, use American English spelling:
-#### Customising Flag Names +#### Customizing Flag Names
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
client/v2/README.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
client/v2/README.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: repo-analysis
- GitHub Check: test-x-epochs
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: Summary
🔇 Additional comments (1)
client/v2/README.md (1)
255-255
: LGTM! Using versioned link instead of main branch.The change to use a versioned link (
release/v0.52.x
) instead of the main branch improves documentation stability.
(cherry picked from commit ac033af)
(cherry picked from commit ac033af)
Description
Use the versioned release link instead of using the main branch
Summary by CodeRabbit
autocli
package