mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Andrew ValleteauandClaude
4612f5687b
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update ## What is the current behavior? Documentation examples show CLI commands with inconsistent flag ordering, where `--project-ref` and other flags appear before subcommands, which doesn't match the actual CLI syntax. ## What is the new behavior? Updated all CLI command examples to use the correct flag ordering where: - The main command comes first - Subcommands follow - Flags come after subcommands Examples updated: - `supabase ssl-enforcement get --project-ref {ref} --experimental` - `supabase secrets set SLACK_TOKEN=... --project-ref nacho_slacker` - `supabase postgres-config update --project-ref <project-ref> --experimental` - `supabase inspect db bloat --db-url postgresql://...` - `supabase vanity-subdomains activate --project-ref abcdefghijklmnopqrst --desired-subdomain my-example-brand --experimental` ## Additional context These changes ensure that documentation examples accurately reflect the actual CLI syntax and will help users avoid command errors when following the guides. https://claude.ai/code/session_01WMx8BBuCJwZfrN1RJhY2Fq <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated multiple CLI examples across database, functions, and platform guides to use consistent, current argument ordering. * Refreshed guidance and examples for Postgres configuration management, database bloat inspection, setting Edge Function secrets, vanity subdomain availability/activation, and SSL enforcement. * No product behavior changed—these updates improve the accuracy and reliability of the documented commands. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude <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.