mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 02:45:07 +03:00
Ali Waseem
0212c52606
The API reference rendered all ~172 endpoints on a single page regardless of URL, so its pre-rendered size grew with the entire API surface. This tripped Vercel's ISR page-size cap (INC-703) once the underlying OpenAPI spec grew. Each endpoint now gets its own statically-generated page at its existing slug URL, bounding page size to one endpoint instead of all of them. Client SDK, CLI, and self-hosting reference pages are unaffected.
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.