mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 21:29:08 +03:00
The build-docs-002-rls-guide eval failed six checks. Each one traces to something the guide doesn't say. - Grants. Add a "Grants and policies" section and rewrite the opening admonition around revoke-then-grant. The guide only ever showed grant, so agents left anon holding insert, update, and delete. - Indexes. Drop the "(or primary keys)" carve-out and explain that a column is indexed only when it leads a btree index, with a composite primary key example. - Tests. Add a "Test your policies" section covering pgTAP file location, supabase test db, role and identity switching, and which assertion matches which denial. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.