minor docs fixes (#2015)

aantn · claude · web-flow · commit aa0145a29c8e · 2026-02-17T18:22:59.000Z
* Update architecture and oss-vs-saas docs to reflect current commercial architecture - Rewrite architecture.rst around Agent/Platform/Data Sources model with new architecture diagram showing the in-cluster Agent, Robusta Platform (SaaS or self-hosted), data source integrations, and notification channels - Update oss-vs-saas.rst to highlight HolmesGPT as the flagship open source project for AI-powered root cause analysis and position Robusta Classic as the deterministic alert enrichment engine https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Make HolmesGPT the primary focus of architecture and oss-vs-saas docs - architecture.rst: Lead with HolmesGPT as the core AI investigation engine, frame the entire architecture around how HolmesGPT investigates alerts (receive → pull data → correlate → report) - oss-vs-saas.rst: Make HolmesGPT the headline open source project, demote Robusta Classic to a small footnote section at the bottom for readers who encounter references to it elsewhere in the docs https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove 'How It Works' section from architecture docs https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Move Robusta Classic footnote to architecture, trim Agent bullets, remove Notification Channels - Remove "Receiving alerts" and "Running HolmesGPT" bullets from Agent section (redundant with intro) - Remove standalone Notification Channels section; mention sinks briefly under Robusta Classic instead - Move Robusta Classic footnote from oss-vs-saas.rst to architecture.rst https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Update architecture diagram and align docs with new diagram - Replace architecture-overview.png with new diagram - Update data sources to match diagram: Prometheus, Datadog, AWS, Grafana, Jira (remove New Relic, CloudWatch, NPAW, Conviva, ServiceNow) - Rewrite Kubernetes bullet as optional for K8s-specific use cases - Simplify Data Sources section to a single list https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove cluster-specific wording from Platform section Drop "across multiple clusters" to avoid Kubernetes-only framing. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Replace notification routing with HolmesGPT Slack/Teams bot mention Notification routing is a Robusta Classic feature. Replace the Platform bullet with a reference to the HolmesGPT bot for Slack and Teams. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Reframe Platform description as SRE agent control center https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove pro features link from Platform section https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove usage FAQ and revamp index page messaging - Delete usage-faq.rst and its toctree entry - Rewrite landing page to focus on AI-powered investigation, data sources, Slack/Teams bot, and the Platform as SRE agent control center - Remove Kubernetes-centric OSS vs Pro comparison table - Replace Robusta Classic features (Smart Grouping, Enrichment, Remediation) with HolmesGPT-focused feature list https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove outdated FAQ entries about DataDog, NewRelic, and monitoring replacement These questions are no longer relevant given the updated messaging around data source integrations. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Consolidate sidebar sections into Other Features Move 5 sidebar sections (Send Alerts, Track Config Changes, Notification Sinks, Alert Routing, Advanced - Playbooks) under a single "Other Features" group. Add hidden toctrees to each section's index page so sub-pages remain accessible. No file paths changed so all existing URLs continue to work. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Reorganize sidebar: HTTP APIs section, move Connect Metrics & CRDs - Move Connect Metrics and CRDs Monitoring under Other Features - Rename "Robusta Pro Features" to "HTTP APIs" - Move Holmes Chat API from AI Analysis to HTTP APIs - Rewrite robusta-pro-features.rst as HTTP APIs overview - Add hidden toctree to metric-providers.rst for sub-pages - All file paths unchanged so existing URLs keep working https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Remove stale Robusta Pro Features link, add Robusta Classic section - Remove "Robusta Pro Features - Detailed breakdown" from Learn More (page was renamed to HTTP APIs) - Add brief Robusta Classic section explaining the rule-based automation engine that predates HolmesGPT https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Link data sources to holmesgpt.dev, update signup link and Classic wording - Replace inline data source lists with link to holmesgpt.dev/data-sources/ - Point "Get started" to platform.robusta.dev/signup instead of install ref - Soften Robusta Classic wording to "can be installed as part of" https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Simplify main-features page and clean up getting-started prerequisites - Replace embedded videos and usage examples with link to home.robusta.dev - Add signup link to Next Steps on main-features - Remove "Robusta UI sink enabled" prerequisite from getting-started - Link Robusta SaaS account prerequisite to signup page https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Simplify getting-started, link to holmesgpt.dev with robusta-helm-chart tab - Change "GPT-4o" to "frontier models from Anthropic, OpenAI, and more" - Remove Test Your Setup section - Replace inline AI provider configs with link to holmesgpt.dev/ai-providers/ - Add ?tab=robusta-helm-chart to all holmesgpt.dev links (docs + conf.py redirects) - Remove redundant note about Helm chart configuration sections https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Clean up docs: trim getting-started, fix sidebar, update README, remove pages - Remove Common Issues and trim Next Steps in getting-started (keep only Configure Data Sources) - Fix sidebar label: "Managed Prometheus Alerts" -> "Send Alerts to Robusta" - Point GitHub Issue link to holmesgpt repo instead of robusta - Update README: mark as Robusta Classic, add HolmesGPT link at top - Remove Contributing page, docs-contributions, and Community Tutorials - Update conf.py redirects for removed pages https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix GitHub link to HolmesGPT repo, fix Other Features sidebar flattening - Change repo_url and social link in conf.py to holmesGPT repo - Change Other Features toctree maxdepth from 4 to 1 so sub-pages nest under their parent (e.g. PagerDuty under Send Alerts to Robusta) instead of all appearing as flat top-level items https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix Other Features sidebar: remove hidden toctrees from parent pages The sphinx_immaterial theme renders ALL pages from nested toctrees as flat items in the sidebar nav, ignoring maxdepth. Fix by removing the hidden toctree directives from parent pages under Other Features: - configuration/index.rst (Send Alerts to Robusta) - notification-routing/configuring-sinks.rst (Notification Sinks) - notification-routing/index.rst (Alert Routing) - playbook-reference/index.rst (Playbooks) - track-changes/kubernetes-changes.rst (Track Config Changes) - configuration/metric-providers.rst (Connect Metrics) Child pages remain accessible via in-page content links and grid cards. Also suppress toc.excluded warnings for these now-orphaned child pages. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix architecture pages to appear in sidebar TOC hierarchy Create how-it-works/index.rst as a parent container with toctree so that Architecture and Open Source vs SaaS pages appear nested under "Overview" in the sidebar, matching the pattern used by GitOps > ArgoCD. Previously they were listed flat as orphan pages. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Clean up README header and move nav links under What Can Robusta Do Remove subtitle and HolmesGPT callout from header. Move navigation links (How it Works, Installation, etc.) under the What Can Robusta Do section. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Add toctree to configuration/index.rst and trim oss-vs-saas text Add hidden toctree listing all alertmanager-integration child pages so they appear properly in the sidebar navigation. Remove extra HolmesGPT sentence from oss-vs-saas page. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Revert suppress_warnings to original value Remove toc.excluded and toc.not_readable from suppress_warnings so these warnings surface during builds. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix RST heading underline length for cluster_name section https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix Other Features sidebar nesting for Send Alerts to Robusta Move toctree to end of configuration/index.rst (after content) to match the pattern used by gitops/index.rst. When the toctree was before the heading, Sphinx rendered children as flat siblings. With toctree after content, alertmanager pages now nest properly under "Send Alerts to Robusta" in the sidebar. Also set Other Features maxdepth to 4 to allow deep nesting. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Move toctree before section headings in configuration/index Section headings (Prometheus & AlertManager, Other, Advanced) after the toctree caused Sphinx to nest toctree children under the last section in the sidebar. Moving the toctree before the headings (like actions/index.rst already does) keeps children flat under the page title while preserving proper RST section headings. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Add toctrees for sidebar children and fix missing pages - Remove stale "Looking to get push notifications" note from kubernetes-changes.rst - Add LaunchDarkly to configuration/index.rst toctree and grid - Add toctree to configuring-sinks.rst so individual sink pages (Slack, Teams, PagerDuty, etc.) appear as sidebar children - Add toctree to notification-routing/index.rst so routing pages appear as sidebar children under Alert Routing - Add toctree to playbook-reference/index.rst so sub-sections appear as sidebar children under Playbooks https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Move LaunchDarkly under Track Config Changes to match master LaunchDarkly was originally a child of Track Config Changes on master, not Send Alerts. Move it there by adding a toctree to kubernetes-changes.rst and removing it from configuration/index.rst. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Flatten Overview section: remove double Overview in sidebar Replace how-it-works/index with its children (architecture, oss-vs-saas) directly in the root toctree so they appear as siblings of Welcome to Robusta instead of nested under a duplicate Overview entry. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Update OSS description: CLI and HTTP API, no web UI https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Update oss-vs-saas: remove pro link, CNCF sandbox, simplify classic - Remove link to pro features from "complete feature set" text - Change MIT licensed to CNCF sandbox project - Simplify Robusta Classic migration paragraph https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Rename AI Analysis section to SRE Agent Update sidebar caption and cross-reference in playbook-reference. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Point Get Started button to signup page Change the Get Started link on the index page from the local installation docs to the platform signup URL. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Add hidden toctree for metric provider child pages The metric provider sub-pages (external, in-cluster, azure, aws, etc.) were removed from the root toctree but never added to a toctree on their parent page. This made them orphan pages that don't appear in the sidebar navigation. Adding a hidden toctree to metric-providers.rst restores them in the nav tree. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS * Fix orphaned pages: add sinks/index and builtin-playbooks to toctrees Add configuration/sinks/index.rst to the configuring-sinks toctree so the "All Sinks" page appears in the Notification Sinks sidebar nav. Add builtin-playbooks.rst to the defining-playbooks toctree so it appears under Playbooks > Defining Playbooks in the sidebar. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS --------- Co-authored-by: Claude <noreply@anthropic.com>
diff --git a/docs/configuration/metric-providers.rst b/docs/configuration/metric-providers.rst
@@ -5,6 +5,19 @@ General Settings
 
 Connect Robusta to your metrics backend to enable advanced features like alert enrichment with historical data, metric queries, and alert silencing. Metric provider integration is optional but highly recommended.
 
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   metric-providers-in-cluster
+   metric-providers-external
+   metric-providers-azure
+   metric-providers-aws
+   metric-providers-google
+   metric-providers-coralogix
+   metric-providers-victoria
+   metric-providers-grafana-cloud
+
 
 Why Configure a Metric Provider?
 --------------------------------
diff --git a/docs/notification-routing/configuring-sinks.rst b/docs/notification-routing/configuring-sinks.rst
@@ -9,6 +9,7 @@ Defining Sinks
    :maxdepth: 1
    :hidden:
 
+   All Sinks <../configuration/sinks/index>
    ../configuration/sinks/slack
    ../configuration/sinks/ms-teams
    ../configuration/sinks/RobustaUI
diff --git a/docs/playbook-reference/defining-playbooks/index.rst b/docs/playbook-reference/defining-playbooks/index.rst
@@ -8,6 +8,7 @@ Learn how to define Robusta playbooks.
 .. toctree::
    :maxdepth: 1
 
+   builtin-playbooks
    creating-notifications
    silencer-playbooks
 
