Miranda Limonczenko
0fc98b6dbc
The section ran concept, fact, procedure, and process together as one stretch of prose, so the two commands the reader has to run were buried in paragraphs between the Docker background and the first-run note. - Lead with the container runtime prerequisite and the runtime list, which is what the reader needs before acting. - Number the four actions, each starting with an imperative verb. What `init` produces stays with the step that runs it. - Close with the first-run download as an outcome. Cut "the most common thing you'll do with the CLI is run the full Supabase stack", which the page's opening sentence now says.
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.