mirror of
https://github.com/supabase/supabase.git
synced 2026-10-12 21:05:06 +03:00
- Promote step headings from h4 to h2 so the heading hierarchy isn't skipped - Convert sequential step bullets to ordered lists - Replace "image" placeholder alt text with descriptive alt text - Use "after" instead of "once" per the docs word list - Replace the blockquote with a note admonition, as blockquotes aren't used in docs - Follow the word list elsewhere: "dialog" instead of "popup", drop "e.g." and parenthetical asides, and avoid "below" as a location reference - Don't rely on color alone to identify the failing log entry Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Gn5pGK4dgfXnh68UJ4VYx2
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.