docs: Expand the readme for the analyst agent - #1147
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe Insights README now documents platform-first persistence, optional local mirroring, analyst deployment configuration, observability settings, and the workflow for Experimentalist to consume Insights. ChangesInsights documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
plugins/nemo-insights/README.md (1)
108-125: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd the required SDK and CLI tab set.
This new section provides shell examples only. Add a Python SDK variant beside the CLI variant. If deployment configuration has no SDK equivalent, state that limitation and link to the supported SDK workflow.
As per coding guidelines, provide both Python SDK and CLI examples in tab-sets for consistency and to support multiple user workflows.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@plugins/nemo-insights/README.md` around lines 108 - 125, Update the “Setting the underscored fields” section to use the repository’s standard CLI/Python SDK tab-set format, retaining the existing CLI commands and adding equivalent Python SDK configuration. If the deployment configuration cannot be set through the SDK, state that limitation and link to the supported SDK workflow.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@plugins/nemo-insights/README.md`:
- Line 48: Update the README sentence about insights reaching the platform to
limit the claim to normal CLI runs, and explicitly document that the analyst
testbed can set local_only=True to skip platform persistence.
- Around line 146-167: Update the “What consumes an Insight” section to replace
the conceptual flow with runnable Experimentalist commands: show a local mirror
using `--insight path/to/insights.yaml`, a multi-Insight mirror adding
`--insight-id <id|title|zero-based-index>`, and a Platform Insight using
`--insight <platform-insight-id> --workspace <workspace> --base-url
<platform-host>`. State that each run selects exactly one Insight.
- Around line 91-134: The observability endpoint validation must not allow HTTP
for 0.0.0.0; restrict the exception to the intended loopback allowlist or
document and enforce the exact allowed addresses. Add configuration tests
covering NEMO_INSIGHTS_ANALYST_RUN_AT_HOUR handling, JSON analyst-object merging
with defaults, and environment values overriding file configuration.
---
Nitpick comments:
In `@plugins/nemo-insights/README.md`:
- Around line 108-125: Update the “Setting the underscored fields” section to
use the repository’s standard CLI/Python SDK tab-set format, retaining the
existing CLI commands and adding equivalent Python SDK configuration. If the
deployment configuration cannot be set through the SDK, state that limitation
and link to the supported SDK workflow.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: cd38d206-2472-4805-9a1e-99aea12ad526
📒 Files selected for processing (1)
plugins/nemo-insights/README.md
callingmedic911
approved these changes
Aug 6, 2026
jeremysilva1098
enabled auto-merge
August 6, 2026 22:10
BrianNewsom
approved these changes
Aug 6, 2026
Contributor
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update to the analyst readme with more detail
Summary by CodeRabbit