mirror of
https://github.com/supabase/supabase.git
synced 2026-10-19 16:19:10 +03:00
Alexis Aguilar
339797498c
## Problem The [Vercel Marketplace guide](https://supabase.com/docs/guides/integrations/vercel-marketplace) describes the integration as a Public Alpha, and its Quickstart doesn't match how readers set it up. The **Deploy with Vercel** button deploys an example app that doesn't include Supabase. The section on environment variable sync sits next to the two setup paths, even though it applies to both. The page also uses promotional phrasing and bare `Note:` paragraphs where the style guide calls for admonitions. These issues came up while reviewing #51617, which fills in the **Via Vercel Marketplace** step. Resolves DOCS-1451. ## Solution Manual review plus a review with the `edit-the-docs` skill. - **Quickstart:** The Quickstart now opens by naming both setup paths, a starter template and the Vercel Marketplace, and explains that both create a Supabase project and sync the same environment variables. The template button deploys the Next.js Supabase starter and installs the Supabase integration from the Vercel Marketplace, matching the deploy link on Vercel's Supabase template page. - **Release status:** The Public Alpha admonition is removed. - **Overview:** Promotional phrases such as "seamless experience" and "easy access management" now name the specific behavior: Vercel bills you, you sign in with your Vercel account, and Vercel team roles carry over to Supabase. - **Studio support:** Readers get a click path for each entry point. The **Integrations** tab opens the Supabase dashboard homepage, and the **Storage** tab opens a specific project. Both tab names match the current Vercel dashboard. Each instruction names the location before the control, and buttons use _click_, per `WORD_LIST.md`. - **Admonitions:** The permissions note is now a `note` admonition. The billing cycle note is a `caution` admonition, because a plan change resets the billing cycle. - **Capitalization:** Common nouns such as organization, project, and integration are lowercase. - **Limitations:** The organization removal bullet now gives the order of operations: delete the associated projects, then uninstall the integration. Two writing patterns from this PR are now proposed as style guide rules in #51632 (DOCS-1452): using _the following_ when a sentence sits between a reference and its list, and putting the location before the action in UI instructions. ## Preview links https://docs-git-alexisa-docs-1451-supabase.vercel.app/docs/guides/integrations/vercel-marketplace ## 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)
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.