Guilherme Souza
a40bf4dfa4
* docs: Update from supabase-py PRs #1240, #1283, #1318 - Add upsert option to create_signed_upload_url (PR #1283) - Add vector and analytics bucket methods documentation (PR #1318) - Add OAuth 2.1 admin endpoints documentation (PR #1240) All features are marked as alpha and may change in the future. # Conflicts: # apps/docs/spec/supabase_py_v2.yml * docs: Add Python examples to guides for supabase-py PRs #1240, #1283, #1318 - Add Python examples to vector bucket guides (creating, storing, querying, working with indexes) - Add Python examples to analytics bucket creation guide - Add Python examples for OAuth admin endpoints (create_client, list_clients) - Add Python example for create_signed_upload_url with upsert option All examples follow existing guide patterns and use proper TabPanel structure. * style: format guides * fix: Quote YAML descriptions with backticks to fix parsing error Fixes YAML parsing error at line 8453 by properly quoting description strings that contain backticks and commas. * fix(docs): match ids for python reference
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.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
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.