Skip to content

docs: clarify health check docs and sync operator intro#1837

Merged
aantn merged 13 commits intomasterfrom
claude/clarify-health-check-docs-EG3vx
Mar 24, 2026
Merged

docs: clarify health check docs and sync operator intro#1837
aantn merged 13 commits intomasterfrom
claude/clarify-health-check-docs-EG3vx

Conversation

@aantn
Copy link
Collaborator

@aantn aantn commented Mar 24, 2026

Summary

  • Remove "You Can Also:" prefix from deployment-verification heading
  • Sync operator intro text across all three pages (README, main docs index, operator index) using the same "Most AI agents" framing
  • Move operator section above the terminal GIF on the main docs page so it's the first thing visitors see

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW

Summary by CodeRabbit

  • Documentation
    • Updated Operator Mode section with expanded descriptions of background operation capabilities, Slack messaging, and GitHub integration features.
    • Added documentation links for Deployment Verification and Scheduled Health Checks.

claude added 11 commits March 24, 2026 06:40
Adds a new section showing how to deploy a HealthCheck alongside your
application to verify the impact of a new deploy. Covers including
health checks in deployment manifests, polling results in CI/CD, and
tips for versioning, timeouts, labels, and ArgoCD integration.

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
…ywhere

- Create dedicated docs/operator/deployment-verification.md with one-time
  and scheduled health check patterns for deploy verification
- Remove inline section from health-checks.md (now on its own page)
- Add to operator .nav.yml (listed second, after overview)
- Link prominently from operator index.md (features + next steps)
- Link from main docs index.md (new "Running in Kubernetes?" section)
- Link from README.md (new bullet points under feature list)

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
Change the ScheduledHealthCheck example from every-15-minutes to once
per day, and add a tip admonition warning about cost implications of
increasing frequency.

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
- Rewrite docs index section from "Running in Kubernetes?" to "Run
  HolmesGPT 24/7" — aligns with KubeCon keynote messaging
- Update README operator bullet to emphasize background monitoring
- Rewrite operator index intro paragraph to match keynote framing
- Clarify that versioned check names apply to one-time HealthChecks
  only, not ScheduledHealthChecks

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
Mention that a complex check could cost $1+ with state-of-the-art
models like Claude Opus, so users understand the cost implications
before increasing schedule frequency.

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
…stack notes

- Move operator section to top of README with "New:" callout
- Add GitHub MCP recommendation so Holmes can open PRs to fix problems
- Clarify that operator checks query any connected data source, not
  just Kubernetes (VMs, cloud services, databases, SaaS platforms)
- Add "Not just Kubernetes" bullet to features in operator index,
  docs index, and README

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
… cost warning

- Remove duplicated ScheduledHealthCheck YAML from deployment-verification
  page, replace with a "You Can Also" cross-link to the dedicated page
- Add cost-per-call warning and frequency table to scheduled-health-checks
  page so cost info lives in one canonical place

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
- Remove "You Can Also:" prefix from deployment-verification heading
- Sync README operator section with the operator index intro (adds
  "Most AI agents" framing and multi-stack paragraph)

https://claude.ai/code/session_01FoAqz3t5mZoEYEbJMurnoW
Signed-off-by: Claude <noreply@anthropic.com>
Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

Tip: disable this comment in your organization's Code Review settings.

@netlify
Copy link

netlify bot commented Mar 24, 2026

Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit 6170955
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69c25801f3063f000818bddb
😎 Deploy Preview https://deploy-preview-1837--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@aantn aantn enabled auto-merge (squash) March 24, 2026 09:23
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 12041403-062a-4b02-92e0-be88f56d7157

📥 Commits

Reviewing files that changed from the base of the PR and between 4b7d2aa and 6170955.

📒 Files selected for processing (1)
  • docs/index.md

Walkthrough

The documentation homepage (docs/index.md) updates the Operator Mode section with expanded introductory text describing continuous background operation, Slack messaging, GitHub integration, and data source query capabilities. Two feature links—"Deployment Verification" and "Scheduled Health Checks"—are added.

Changes

Cohort / File(s) Summary
Documentation Update
docs/index.md
Expanded operator feature section with additional descriptive copy and new feature links; removed previous section version and omitted "Not just Kubernetes" bullet.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • Sheeproid
  • arikalon1
  • pavangudiwada
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: clarifying health check documentation and synchronizing operator introduction text across documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aantn aantn merged commit 2b95136 into master Mar 24, 2026
10 of 13 checks passed
@aantn aantn deleted the claude/clarify-health-check-docs-EG3vx branch March 24, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants