-
Notifications
You must be signed in to change notification settings - Fork 423
docs: update top-level README with libraries; remove outdated uvloop #926
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: update top-level README with libraries; remove outdated uvloop #926
Conversation
Signed-off-by: Will Killian <[email protected]>
WalkthroughDocumentation updated to mention Google ADK, switch references from workflow.yaml to workflow.yml, adjust roadmap statuses, and expand acknowledgements. Two example configuration files removed the use_uvloop setting; no other config or control flow changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
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: 1
🧹 Nitpick comments (2)
README.md (2)
40-40: Nice addition of Google ADK; consider minor consistency tweaks.
- Use “NeMo Agent Toolkit” capitalization in this sentence for consistency with branding elsewhere.
- Optional: standardize ADK link target (docs vs GitHub) across the README to a single canonical URL.
187-199: Acknowledgements additions look accurate; minor polish optional.
- Consider using a consistent link style for Google ADK (either docs or GitHub) throughout the README.
- Optional: alphabetize or group entries for easier scanning.
Confirm Redis link intentionally targets redis-py (client) vs core redis repo.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(5 hunks)examples/evaluation_and_profiling/email_phishing_analyzer/configs/config_optimizer.yml(0 hunks)examples/frameworks/adk_demo/configs/config.yml(0 hunks)
💤 Files with no reviewable changes (2)
- examples/frameworks/adk_demo/configs/config.yml
- examples/evaluation_and_profiling/email_phishing_analyzer/configs/config_optimizer.yml
🧰 Additional context used
📓 Path-based instructions (2)
**/README.@(md|ipynb)
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Ensure READMEs follow the naming convention; avoid deprecated names; use “NeMo Agent Toolkit” (capital T) in headings
Files:
README.md
**/*
⚙️ CodeRabbit configuration file
**/*: # Code Review Instructions
- Ensure the code follows best practices and coding standards. - For Python code, follow
PEP 20 and
PEP 8 for style guidelines.- Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
Example:def my_function(param1: int, param2: str) -> bool: pass- For Python exception handling, ensure proper stack trace preservation:
- When re-raising exceptions: use bare
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.exception()) to avoid duplicate stack trace output.- When catching and logging exceptions without re-raising: always use
logger.exception()
to capture the full stack trace information.Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any
words listed in the
ci/vale/styles/config/vocabularies/nat/reject.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile are OK.Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,
and should contain an Apache License 2.0 header comment at the top of each file.
- Confirm that copyright years are up-to date whenever a file is changed.
Files:
README.md
🔇 Additional comments (2)
README.md (2)
140-144: LGTM on command/file consistency.The nat run command matches the new workflow.yml filename.
171-174: Roadmap updates read well.Marking Google ADK and MCP items as completed looks accurate.
|
/merge |
Description
use_uvloop: trueCloses
By Submitting this PR I confirm:
Summary by CodeRabbit
Documentation
Chores