Miranda Limonczenko
0d571d4633
Findings from an audit against CONTRIBUTING.md and WORD_LIST.md. Word list: - `directory`, not `folder`, in command-line contexts - `might`, not `may`, for possibility - present tense, not `will`, for a predictable result - a noun after `this` where the referent could be unclear - no `above` to point at another part of the page - concrete verbs for `manage` and `working with`, so the group heading becomes Change your CLI version - no `latest` or `new` as a time-relative description - `enable` used consistently against `disable` CONTRIBUTING: - no parentheses for supplementary information, so the container runtime list becomes a table of tool and platforms - imperative verb to open each step of the Quickstart list - short, direct sentences in the analytics socket explanation - descriptive link text for the CLI releases page - the pre-upgrade admonition states its impact first, and is a caution rather than a note because it can lose local schema and data - the intro navigation lists every group
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.