mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 10:55:06 +03:00
Yogeshwaran CandChris Chinchilla
c84d9856ae
## What kind of change does this PR introduce? Documentation improvement ## What is the current behavior? The documentation for using custom schemas is buried under the REST API section (`/guides/api/using-custom-schemas`), making it hard for users to find when they first encounter schemas in the database documentation. Users who create custom schemas often don't realize they need to configure API access and grant permissions, leading to confusion. Closes #39856 ## What is the new behavior? Three improvements to make custom schemas documentation more discoverable: 1. **Cross-reference in tables page**: Added an admonition tip after the "Schemas" section in `/guides/database/tables` linking to both the "Using Custom Schemas" guide and the "Hardening the Data API" guide 2. **Navigation sidebar**: Added "Using Custom Schemas" link under "Database > Access and security" in the sidebar navigation, so users can find it from the database section without having to navigate to the API section 3. **service_role mention**: Updated the schema grants example in "Hardening the Data API" to include `service_role` alongside `anon` and `authenticated`, since users with server-side access also need this grant ## Additional context The issue author spent hours debugging custom schema access because the documentation wasn't linked from where schemas are first introduced (the database tables page). These changes create a clear path from learning about schemas → configuring API access → security hardening. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added "Using Custom Schemas" guide to the navigation menu under Database -> Access and security section * Enhanced Data API hardening documentation with clarification on service_role permissions for server-side database access * Added instructional tips regarding custom schema exposure via Data API and proper permission configuration <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris@chrischinchilla.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.