Update Send Alerts API documentation to focus on HolmesGPT#2068
Merged
Update Send Alerts API documentation to focus on HolmesGPT#2068
Conversation
Reframe the page so it leads with Holmes investigating sent alerts, and drop the generic benefits list and timeline screenshot.
The exporting docs section is already commercial-only, so the inline banner doesn't add information.
|
✅ Docker image ready for
Use this tag to pull the image for testing. 📋 Copy commandsgcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:712c5e7
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:712c5e7 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:712c5e7
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:712c5e7Patch Helm values in one line: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:712c5e7 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughRewords the Send Alerts API documentation: removes the "Why Send Your Alerts to Robusta?" section and its image, opens the page directly with the "Integration Methods" heading and a statement that alerts can be sent to Robusta for HolmesGPT AI-powered root cause analysis, and drops the edition-availability note from the API section. ChangesSend Alerts API Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 3/5 reviews remaining, refill in 21 minutes and 41 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/configuration/exporting/send-alerts-api.rst (2)
4-10: ⚡ Quick winMake HolmesGPT/Holmes naming consistent.
The intro mixes “HolmesGPT” (Line 4) with “Holmes” (Line 9). Please pick one term and use it consistently across both sentences/bullets to avoid confusion and keep branding uniform.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/configuration/exporting/send-alerts-api.rst` around lines 4 - 10, The intro uses two different product names ("HolmesGPT" and "Holmes"); pick one canonical term (e.g., "HolmesGPT") and update the text so both sentences and any following bullets consistently use that chosen name; specifically replace the other occurrence of "Holmes" with the chosen canonical name in the paragraph that currently reads "Holmes investigates the alert..." and any nearby headings or occurrences in this section to ensure uniform branding.
4-4: ⚡ Quick winConsider softening the “skip manual triage” phrasing.
Line 4 says HolmesGPT “then attaches its findings so you can skip the manual triage step.” If there are cases where manual review is still needed, this wording could over-promise. Consider reframing to “reduce” or “accelerate” triage rather than guaranteeing it’s fully skipped.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/configuration/exporting/send-alerts-api.rst` at line 4, Update the sentence that currently reads "then attaches its findings so you can skip the manual triage step" to soften the guarantee; replace that phrase with wording such as "then attaches its findings to help reduce or accelerate manual triage" (or similar phrasing like "help reduce the need for manual triage" / "help accelerate triage") so the docs avoid over-promising; locate the exact string "skip the manual triage step" in the doc and make the substitution.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/configuration/exporting/send-alerts-api.rst`:
- Around line 4-10: The intro uses two different product names ("HolmesGPT" and
"Holmes"); pick one canonical term (e.g., "HolmesGPT") and update the text so
both sentences and any following bullets consistently use that chosen name;
specifically replace the other occurrence of "Holmes" with the chosen canonical
name in the paragraph that currently reads "Holmes investigates the alert..."
and any nearby headings or occurrences in this section to ensure uniform
branding.
- Line 4: Update the sentence that currently reads "then attaches its findings
so you can skip the manual triage step" to soften the guarantee; replace that
phrase with wording such as "then attaches its findings to help reduce or
accelerate manual triage" (or similar phrasing like "help reduce the need for
manual triage" / "help accelerate triage") so the docs avoid over-promising;
locate the exact string "skip the manual triage step" in the doc and make the
substitution.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0263c646-400e-422d-8e7c-00d9894f0a84
📒 Files selected for processing (1)
docs/configuration/exporting/send-alerts-api.rst
…laim Address CodeRabbit nitpicks: standardize on "HolmesGPT" instead of mixing it with "Holmes", and reframe "skip the manual triage step" as "accelerate triage" to avoid over-promising.
nimrik
approved these changes
May 4, 2026
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.
Summary
Updated the Send Alerts API documentation to refocus the messaging around HolmesGPT's AI-powered root cause analysis capabilities rather than general alert management benefits.
Key Changes
Notable Details
The documentation now emphasizes the core value proposition of automated AI investigation and triage, positioning HolmesGPT as the primary benefit of sending alerts to Robusta rather than focusing on alert aggregation and history features.
https://claude.ai/code/session_012jM54fvj27H8feByzcED2a