chore: remove all unnecessary docker deployment guides from examples#1655
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughThe PR removes Dockerfile configurations and Docker deployment documentation from four example projects (email_phishing_analyzer, agno_personal_finance, simple_calculator, simple_web_query), eliminating containerized build instructions and related deployment guidance while updating associated README files. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
examples/getting_started/simple_web_query/README.md (1)
54-55: Add a blank line after the### Set Up API Keysheading for consistency and compatibility.You should put blank lines before and after a heading for compatibility. The
### Install this Workflowheading (Line 46) correctly has a blank line before its content, but### Set Up API Keysjumps straight to the paragraph on the next line.✏️ Proposed fix
### Set Up API Keys + If you have not already done so, follow the [Obtaining API Keys](../../../docs/source/get-started/quick-start.md#obtaining-api-keys) instructions to obtain an NVIDIA API key.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/getting_started/simple_web_query/README.md` around lines 54 - 55, The "### Set Up API Keys" heading lacks a blank line after it, breaking consistency; edit the README so that the "### Set Up API Keys" heading has an empty line after the heading (and ensure there is a blank line before the heading if missing) so the paragraph below starts after a blank line—look for the literal heading "### Set Up API Keys" and insert the missing blank line to match the other headings like "### Install this Workflow".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@examples/getting_started/simple_web_query/README.md`:
- Around line 54-55: The "### Set Up API Keys" heading lacks a blank line after
it, breaking consistency; edit the README so that the "### Set Up API Keys"
heading has an empty line after the heading (and ensure there is a blank line
before the heading if missing) so the paragraph below starts after a blank
line—look for the literal heading "### Set Up API Keys" and insert the missing
blank line to match the other headings like "### Install this Workflow".
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfileexamples/evaluation_and_profiling/email_phishing_analyzer/README.mdexamples/frameworks/agno_personal_finance/Dockerfileexamples/frameworks/agno_personal_finance/README.mdexamples/getting_started/simple_calculator/Dockerfileexamples/getting_started/simple_calculator/README.mdexamples/getting_started/simple_web_query/Dockerfileexamples/getting_started/simple_web_query/README.md
💤 Files with no reviewable changes (7)
- examples/evaluation_and_profiling/email_phishing_analyzer/README.md
- examples/frameworks/agno_personal_finance/README.md
- examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfile
- examples/getting_started/simple_calculator/README.md
- examples/getting_started/simple_calculator/Dockerfile
- examples/getting_started/simple_web_query/Dockerfile
- examples/frameworks/agno_personal_finance/Dockerfile
|
/merge |
1 similar comment
|
/merge |
…VIDIA#1655) - Docker deployment is not needed for simple agents - Remove docker deployment + instructions for these simple agents - Remove outdated prerequisites Closes ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **Documentation** * Removed Docker deployment instructions from example guides * Simplified installation workflows and setup procedures * Added API key configuration guidance to examples * **Chores** * Removed Docker container configuration files from example projects Authors: - Will Killian (https://github.com/willkill07) Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) URL: NVIDIA#1655
Description
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit
Documentation
Chores