mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03:00
Danny White
b37272cdd7
## What kind of change does this PR introduce? Docs update and UI copy improvement. ## What is the current behavior? The GitHub integration working directory helper uses an inline tooltip for examples. In the form layout, the tooltip alignment and inline code wrapping can make the helper harder to scan. The integration settings pages also mix markdown-rendered copy with JSX copy, duplicate the integration cover image helper, and use slightly different heading, spacing, and button copy patterns across GitHub, Vercel, and AWS PrivateLink. ## What is the new behavior? The GitHub working directory field now keeps the helper copy concise and links to a dedicated docs section with examples for repository root and nested `supabase/` directories. The integration settings sections now use a more consistent JSX structure and copy treatment across GitHub, Vercel, and AWS PrivateLink, including shared cover imagery and matching explanatory section hierarchy. | Before | After | | --- | --- | | <img width="1838" height="696" alt="CleanShot 2026-04-24 at 14 35 32@2x" src="https://github.com/user-attachments/assets/f9843018-fbf5-4c18-a0c3-1842b665f3fd" /> | <img width="1842" height="700" alt="CleanShot 2026-04-24 at 14 30 21@2x-64E8726E-0B89-4C5A-8A47-CE1AA24F3D1A" src="https://github.com/user-attachments/assets/bb017464-2b43-4dfe-94b8-a586aedea318" /> | | <img width="1884" height="1432" alt="CleanShot 2026-04-24 at 14 40 19@2x" src="https://github.com/user-attachments/assets/b34e4573-cd7c-4588-83a0-0e1941019552" /> | <img width="1844" height="1424" alt="CleanShot 2026-04-24 at 14 39 02@2x" src="https://github.com/user-attachments/assets/4f82b01c-cb27-4f01-b2da-76b7f6e298a5" /> | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified GitHub integration setup: provide a Working directory value, how to compute it from the repo root (including "." for root), examples, and updated “initialize” spelling. * **Refactor** * Simplified integration form descriptions (tooltips → inline text + Learn more link). * Reworked GitHub and Vercel integration content to use consistent headings, layout, and shared image handling. * Reorganized integration settings rendering for clearer UI states. * **Style** * Minor copy, casing, and button text/spacing adjustments. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
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.