-
Notifications
You must be signed in to change notification settings - Fork 761
docs: Update main readme with Deepwiki and new documentation and examples links #1510
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
Conversation
Signed-off-by: Harry Kim <[email protected]>
WalkthroughThe README.md file was updated to include a new "Ask DeepWiki" badge, reorganize and simplify navigation links, and remove an announcement about an in-person meetup. These updates affect the project's introductory documentation and external references. Changes
Possibly related PRs
Poem
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
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 (1)
README.md (1)
22-22: Nit: Standardize badge style for consistencyThe
Ask DeepWikibadge uses a direct SVG link, which visually differs from the existing shields.io badges. Consider switching to a shields.io–styled badge for DeepWiki to maintain a uniform appearance.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and Test - vllm
🔇 Additional comments (1)
README.md (1)
24-24: Updated navigation links look goodThe streamlined set of links correctly points to Roadmap, Documentation, Examples, and Design Proposals. All URLs appear valid and up-to-date.
Adds
Removes
Summary by CodeRabbit