-
Notifications
You must be signed in to change notification settings - Fork 571
fix(docs): Update README link #284
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
fix(docs): Update README link #284
Conversation
Link README's `contributing` to CONTRIBUTING.md. Previous links where to now-moved sections within README.
WalkthroughThe Table of Contents in the README.md was modified by removing the detailed list of contributing subsections and replacing it with a single link to the CONTRIBUTING.md file, streamlining the documentation reference. Changes
Possibly related PRs
Suggested labels
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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 (
|
Thanks @david-hamilton-glean! |
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 (1)
README.md (1)
100-100
: Use a relative link to CONTRIBUTING.md
A leading slash makes this an absolute URL on GitHub (e.g.https://github.com/CONTRIBUTING.md
). It’s better to link relatively so it resolves to the file in this repo:- - [Contributing](/CONTRIBUTING.md) + - [Contributing](CONTRIBUTING.md)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
100-100: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
100-100: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (1)
README.md (1)
100-100
: Docs link updated correctly
The Table of Contents now points to the dedicatedCONTRIBUTING.md
guide as intended.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
100-100: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
Description
Link README's
contributing
to CONTRIBUTING.md. Previous links where to now-moved sections within README.Type of Change
Checklist
MCP Spec Compliance
Additional Information
Summary by CodeRabbit