mirror of
https://github.com/supabase/supabase.git
synced 2026-10-19 08:09:11 +03:00
Alexis AguilarandMiranda Limonczenko
add223d7b3
## Problem Two writing patterns came up while editing the Vercel Marketplace guide in #51630, and the style guide doesn't cover either one. - **References to a list:** When another sentence sits between a reference and its list, as in "start from these tabs. Each one opens a different page:", _these_ has nothing to point back to. Nothing in the style guide covers this. - **Order of UI instructions:** Nothing says whether an instruction names the location or the control first. "Click **Manage** next to Supabase" asks the reader to look for **Manage** before they know where it is. Resolves DOCS-1452. ## Solution `02-elements.md` gets a new rule for lists and an addition to the existing step guidance, each with a recommended and a not recommended example. - **Point forward to a list with _the following_** (under **Lists**): When another sentence sits between a reference and its list, use _the following_, which points forward. When the reference is directly before the list, _these_ works too. - **Location before the action** (under **Procedures**): The step guidance now says that a step can begin with a short location phrase followed by the imperative verb, and that when a step says where to act, the location comes first. The examples use _click_ for buttons, following the `click` and `select` entries in `WORD_LIST.md`. ## Review instructions 1. Open `apps/docs/style-guide/02-elements.md` in the **Files changed** tab. 2. Read **Point forward to a list with _the following_** under **Lists**, and confirm that the examples separate the two cases: a reference directly before the list, and one with a sentence in between. 3. Read the step guidance at the start of **Procedures**, and confirm that the examples agree with the `click` entry in `WORD_LIST.md`. ## Checklist Check all before review: - [x] I have read [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) - [x] If I wrote a new docs topic or edited an existing topic, I used the `/write-the-docs` or `/edit-the-docs` skill, which applies the docs [style guide](https://github.com/supabase/supabase/tree/master/apps/docs/style-guide) --------- Co-authored-by: Miranda Limonczenko <miranda.limonczenko@supabase.io>
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.