Add Health Endpoints documentation page

[mxkaske]

Summary

Adds comprehensive documentation for the @openstatus/health package, a toolkit for building health endpoints that monitor service dependencies and report their status.

Changes

• New documentation page (apps/web/src/content/pages/unrelated/health.mdx):

  • Introduction explaining the difference between health endpoints and uptime checks
  • Installation instructions for npm and JSR
  • Quickstart example showing how to set up a health handler with multiple probes
  • Framework compatibility guide (Next.js, SvelteKit, Astro, Nitro, Fresh, React Router, Bun, Deno, and adapters for Hono, Express, Elysia, TanStack Start)
  • Response format documentation with status codes and HTTP behavior
  • Probe configuration reference including timeout, skip conditions, and abort signal handling
  • Package family overview (adapters, probes, and hosting packages)
  • Configuration options table with defaults and descriptions
  • Real-world usage example from the openstatus API
  • Integration guide for monitoring with openstatus HTTP monitors
  • FAQ section covering common questions about health endpoints vs uptime checks, dependencies, framework support, caching, and security
  • Links to repository, JSR, HTTP monitor reference, and support channels

• Updated navigation (apps/web/src/data/content.ts):

  • Added "Health Endpoints" link to the tools section navigation

Implementation Details

The documentation follows the existing pattern in the codebase with frontmatter metadata (title, publishedAt, author, description, category) and includes an FAQ section for common questions. The page provides both conceptual understanding and practical implementation guidance, with code examples for different runtime environments and frameworks.

https://claude.ai/code/session_01EGb6YobahotZrmZPG9LRcA

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
openstatus-web	Ready	Preview	Sep 17, 2026 10:08am UTC

2 Skipped Deployments

Project	Deployment	Actions	Updated
openstatus-dashboard	Skipped		Sep 17, 2026 10:08am UTC
openstatus-status-page	Skipped		Sep 17, 2026 10:08am UTC

[cubic-dev-ai]

No issues found across 2 files

_{Re-trigger cubic}

[mxkaske]

🧪 api is red on c997560, and it isn't this PR's

Failure: run with includeStatusReports creates status reports — packages/api/src/router/import.test.ts:444. The incidents phase came back partial where the test asserts completed. 43 passed, 1 failed.

Why it isn't this PR's: the diff is three content files under apps/web (one .mdx page and two nav lists). packages/api is byte-identical across all four commits on this branch, and this same job passed on d074e71 and be3197e — the base has been 772656f throughout. No change here can reach the importer.

No fix ported, because none exists yet. This looks like a pre-existing test-isolation problem rather than a product bug. mockStatuspageFetch() (import.test.ts:38) assigns globalThis.fetch and restoreFetch() puts it back, and the run shows sibling suites (trpc.test.ts, statusPage.e2e.test.ts) in the same process. If the mock is restored while an import is still in flight, some incidents fail their fetch and the phase degrades to partial — exactly the observed symptom, and exactly the kind of interference the file already warns about at line 74 ("only holds if no sibling suite writes to the same page"). Making that robust means touching the importer's test harness, which is well outside a docs PR, so I have not widened this one to do it.

I could not spend the re-run: rerun-failed-jobs returns 403 Resource not accessible by integration for me. A maintainer re-run of run 35208698068 should settle it — if it goes green, this was the flake; if it reproduces identically, the isolation bug above is worth its own issue.

I'm still watching this PR and will keep driving the rest to green.

---

Generated by Claude Code