diff --git a/apps/reference/README.md b/apps/reference/README.md index 7ae88ade7d0..36886fbeb4e 100644 --- a/apps/reference/README.md +++ b/apps/reference/README.md @@ -1,45 +1,5 @@ # Reference Docs -Supabase Reference Docs +## Deprecation notice -## 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: - -1. Guides: teach developers how to use a product. "I have XX problem, how do I solve it?" -2. Tutorials: walk-throughs, have a large outcome. "Build a React application with Supabase". -3. Explanations: teach developers about a broad topic. "What is a database?" -4. 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. +This directory is the old Supabase docs site. We have migrated to a new `docs` [(supabase/apps/docs)](https://github.com/supabase/supabase/tree/master/apps/docs) directory in November 2022 and will be removing this `reference` directory soon. Any contributions to docs going forward should be made in `docs` and not `reference`.