Files
supabase/apps/docs
Steven EubankandClaude Sonnet 4.6 c64570a443 docs: add Health Advisor page and nav entry
New observability/health-advisor.mdx documents the 8 on-demand runtime
checks (DB connectivity, instance health, per-service error rates).
advisors.mdx updated to mention Health Advisor alongside security and
performance advisors. Nav entry added under Advisors.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-09-04 15:03:50 +02:00
..
2026-07-01 12:59:00 +02:00

Reference Docs

Supabase Reference Docs

Maintainers

If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.

DocSpec

We use documentation specifications which can be used to generate human-readable docs.

  • OpenAPI: for documenting API endpoints.
  • SDKSpec (custom to Supabase): for SDKs and client libraries.
  • ConfigSpec (custom to Supabase): for configuration options.
  • CLISpec (custom to Supabase): for CLI commands and usage.

The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.

Contributing

To contribute to docs, see the developers' guide and contributing guide.