Files
supabase/apps/docs
Guilherme Souza 3d6fc67474 chore(test): add swift TypeDoc JSON from CI artifact for e2e testing
Generated from supabase/supabase-swift#1034 workflow run 28107689217.
This file is normally gitignored and downloaded at build time via the
Makefile download.swift.v2 target once GitHub Pages is enabled.
Force-added here only to unblock e2e pipeline testing.
2026-06-24 12:04:50 -03:00
..

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.