mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
58de4a4f1b
* feat: initial commit * feat: add mfa verification hook feat: update docs fix: add section on writing own hook feat: update guide * feat: temp comit * feat: update files * feat: fix link * fix: update copy * Apply suggestions from code review * feat: restructure content * feat: subclass examples into accordions * feat: reinstate backticks * Apply suggestions from code review Co-authored-by: Kang Ming <kang.ming1996@gmail.com> * Apply suggestions from code review Co-authored-by: Kang Ming <kang.ming1996@gmail.com> Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * Update apps/docs/pages/guides/auth/auth-postgres-hooks.mdx Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * Update apps/docs/pages/guides/auth/auth-postgres-hooks.mdx Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * Update apps/docs/pages/guides/auth/auth-postgres-hooks.mdx Co-authored-by: Kang Ming <kang.ming1996@gmail.com> * Update apps/docs/pages/guides/auth/auth-postgres-hooks.mdx Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * refactor: dump hooks into table * refactor: restructure content * refactor: change structure * feat: add information about required claims * feat: move claims into table * feat: update structure * feat: update with warning about jsonb operator * Apply suggestions from code review Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * feat: remove image of dashboard, address more comments * feat: add additional plv8 and pg_net examples * feat: swap out image, use 2 space tabs * feat: format email requests * Update apps/docs/pages/guides/auth/auth-postgres-hooks.mdx Co-authored-by: Kang Ming <kang.ming1996@gmail.com> * docs: rewrite headers to active * feat: add instructions on storing in vault * Apply suggestions from code review Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com> * refactor: rephrase docs * feat: drop headings * chore: delete unused lines * feat: address changes * feat: rename fields * feat: update example from testing * fix: moinor owrding change * Apply suggestions from code review * Update apps/docs/pages/guides/auth/auth-hooks.mdx * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Update apps/docs/pages/guides/auth/auth-hooks.mdx * Apply suggestions from code review Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com> * feat: make tabs active * fix: remove unused files --------- Co-authored-by: joel@joellee.org <joel@joellee.org> Co-authored-by: Kang Ming <kang.ming1996@gmail.com> Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>
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.
Types of docs
There are many types of docs:
- Guides: teach developers how to use a product. "I have XX problem, how do I solve it?"
- Tutorials: walk-throughs, have a large outcome. "Build a React application with Supabase".
- Explanations: teach developers about a broad topic. "What is a database?"
- Reference: technical descriptions of tools and how to use them. "What errors does the API return?"
In these docs, you should focus only on the fourth type: "Reference Docs".
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 any documentation system we want. On this site we use Next.JS, but in Supabase's official website we use a custom React site and expose only a subset of the available API for each tool.