mirror of
https://github.com/supabase/supabase.git
synced 2026-06-12 00:01:19 +08:00
a40252e6c1
## 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** * Simplified the local setup instructions for running the docs site during development. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
# 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](https://github.com/supabase/supabase/blob/master/apps/docs/DEVELOPERS.md) and [contributing guide](https://github.com/supabase/supabase/blob/master/apps/docs/CONTRIBUTING.md).
|