mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 19:35:06 +03:00
Chris Chinchilla
fd61ef995f
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated CLI installation guidance to recommend “global CLI usage” phrasing and link to platform-specific installation pages * Removed duplicate legacy note in the npm install guidance * Reworded CLI update guidance to state updates use the “same channels” * Expanded “Running Supabase locally” walkthrough with clear post-init steps, start instructions, and clarified credentials output * Clarified analytics schema wording from “will be stored” to “are stored” <!-- 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.
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.