Julien GouxandIvan Vasilov
7b08726d3a
Document `supabase init --use-orioledb` in the CLI reference. Add `db.orioledb_version` to the CLI config reference, and mark `experimental.orioledb_version` as deprecated. This complements the general OrioleDB beta guide update in #50813. Companion CLI PR: https://github.com/supabase/cli/pull/6828, released in [v2.119.0](https://github.com/supabase/cli/releases/tag/v2.119.0). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Documented the `supabase init --use-orioledb` option, which sets the OrioleDB image version in `supabase/config.toml`. * Added configuration guidance for `db.orioledb_version`, including its PostgreSQL version requirements. * Marked `experimental.orioledb_version` as deprecated and directed users to `db.orioledb_version`. The CLI continues to read the experimental setting and warns when it is set. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.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 style guide for how to write a page, and the developers' guide and contributing guide for repo mechanics. If you write with an AI coding agent, use the /write-the-docs skill to draft and /edit-the-docs to revise an existing page.