-## Manage your Edge Functions {#supabase-functions}
+## Stop the Supabase local development setup {#supabase-stop}
-Manage your Edge Functions.
### Usage
```sh
-supabase functions [command] [flags]
+supabase stop [flags]
```
+### Options
+
+```sh
+ -h, --help help for stop
+```
+
+
+
+
+
+
+
+## Show status of the Supabase local development setup {#supabase-status}
+
+
+
+
+### Usage
+
+```sh
+supabase status [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for status
+```
+
+
+
+
+
+
+
+## Start the Supabase local development setup {#supabase-start}
+
+
+
+
+### Usage
+
+```sh
+supabase start [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for start
+```
+
+
+
+
+
+
+
+## List all projects {#supabase-projects-list}
+
+
+
+
+### Usage
+
+```sh
+supabase projects list [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for list
+```
+
+
+
+
+
+
+
+## Create a new project {#supabase-projects-create}
+
+
+
+
+### Usage
+
+```sh
+supabase projects create [flags]
+```
+
+
+
+### Options
+
+```sh
+ --db-password string Database password of the project.
+ -h, --help help for create
+ --org-id string Organization ID to create the project in.
+ --plan string Select a plan that suits your needs. Can be "free" or "pro". (default "free")
+ --region string Select a region close to you for the best performance.
+```
+
+
+
+
+
+
-## Create an Edge Functions {#supabase-functions-new}
+## Serve a Function locally {#supabase-functions-serve}
-Create an Edge Functions.
### Usage
```sh
-supabase functions new
+supabase functions serve [flags]
```
-
### Options
+```sh
+ --env-file string Path to an env file to be populated to the Function environment.
+ -h, --help help for serve
+ --no-verify-jwt Disable JWT verification for the Function.
```
--h, --help help for functions
-```
-
@@ -80,27 +614,24 @@ supabase functions new
-## Deploy an Edge Functions {#supabase-functions-deploy}
+## Create a new Function locally {#supabase-functions-new}
-Deploy an Edge Functions.
### Usage
```sh
-supabase functions deploy
-````
-
+supabase functions new [flags]
+```
### Options
+```sh
+ -h, --help help for new
```
--h, --help help for functions
-```
-
@@ -108,25 +639,413 @@ supabase functions deploy
-## Delete an Edge Functions {#supabase-functions-delete}
+## Deploy a Function to the linked Supabase project {#supabase-functions-deploy}
-Delete an Edge Functions.
### Usage
```sh
-supabase functions delete
+supabase functions deploy [flags]
```
-
### Options
-```
--h, --help help for functions
+```sh
+ -h, --help help for deploy
+ --no-verify-jwt Disable JWT verification for the Function.
+ --project-ref string Project ref of the Supabase project.
```
+
+
+
+
+
+## Delete a Function from the linked Supabase project. This does NOT remove the Function locally.
+ {#supabase-functions-delete}
+
+
+
+
+### Usage
+
+```sh
+supabase functions delete [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for delete
+ --project-ref string Project ref of the Supabase project.
+```
+
+
+
+
+
+
+
+## Set the remote database to push migrations to {#supabase-db-remote-set}
+
+
+
+
+### Usage
+
+```sh
+supabase db remote set [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for set
+```
+
+
+
+
+
+
+
+## Commit changes on the remote database since the last pushed migration
+ {#supabase-db-remote-commit}
+
+
+
+
+### Usage
+
+```sh
+supabase db remote commit [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for commit
+```
+
+
+
+
+
+
+
+## Print changes on the remote database since the last pushed migration
+ {#supabase-db-remote-changes}
+
+
+
+
+### Usage
+
+```sh
+supabase db remote changes [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for changes
+```
+
+
+
+
+
+
+
+## Push new migrations to the remote database {#supabase-db-push}
+
+
+
+
+### Usage
+
+```sh
+supabase db push [flags]
+```
+
+
+
+### Options
+
+```sh
+ --dry-run Print the migrations that would be applied, but don't actually apply them.
+ -h, --help help for push
+```
+
+
+
+
+
+
+
+## Diffs the local database for schema changes {#supabase-db-diff}
+
+
+
+
+### Usage
+
+```sh
+supabase db diff [flags]
+```
+
+
+
+### Options
+
+```sh
+ -f, --file string Saves schema diff to a file.
+ -h, --help help for diff
+ -s, --schema strings List of schema to include. (default [public])
+ --use-migra Use migra to generate schema diff.
+```
+
+
+
+
+
+
+
+## Switch the active branch {#supabase-db-branch-switch}
+
+
+
+
+### Usage
+
+```sh
+supabase db branch switch [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for switch
+```
+
+
+
+
+
+
+
+## List branches {#supabase-db-branch-list}
+
+
+
+
+### Usage
+
+```sh
+supabase db branch list [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for list
+```
+
+
+
+
+
+
+
+## Delete a branch {#supabase-db-branch-delete}
+
+
+
+
+### Usage
+
+```sh
+supabase db branch delete [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for delete
+```
+
+
+
+
+
+
+
+## Create a branch {#supabase-db-branch-create}
+
+
+
+
+### Usage
+
+```sh
+supabase db branch create [flags]
+```
+
+
+
+### Options
+
+```sh
+ -h, --help help for create
+```
+
From f4136d7224b95fdc34d18419b67750403929ab2e Mon Sep 17 00:00:00 2001
From: Copple <10214025+kiwicopple@users.noreply.github.com>
Date: Wed, 10 Aug 2022 13:46:32 +0200
Subject: [PATCH 05/16] fixes all the nav links
---
apps/reference/docs/about.md | 466 +-----------------
apps/reference/docs/reference.md | 465 +++++++++++++++++
apps/reference/docusaurus.config.js | 18 +-
apps/reference/nav/_referenceNavbar.js | 42 +-
apps/reference/nav/_referenceSidebars.js | 26 +-
apps/reference/package.json | 2 +-
.../theme/DocSidebar/Desktop/Content/index.js | 14 +-
7 files changed, 520 insertions(+), 513 deletions(-)
create mode 100644 apps/reference/docs/reference.md
diff --git a/apps/reference/docs/about.md b/apps/reference/docs/about.md
index e19ffb81f44..fc881d9f35a 100644
--- a/apps/reference/docs/about.md
+++ b/apps/reference/docs/about.md
@@ -1,467 +1,9 @@
---
id: about
+title: Introduction
+description: 'What is Supabase?'
slug: /
-sidebar_label: About
-sidebar_position: 2
+hide_table_of_contents: true
---
-# Reference Documentation
-
-This section of the docs provides technical descriptions of the products and how to use them.
-
-## Modularity
-
-Supabase is modular. While it may seem like a single tool, it is actually a suite of tools that are composed on top of a PostgreSQL database. This offers several advantages:
-
-- Each tool scales independently.
-- Each tool can be self-hosted.
-- Developers can disable tools which are not required.
-- Each tool is focused on a single task to minimize complexity.
-
-This is a similar approach to any Enterprise-grade system with an additional focus on modularity: while some companies might cut-corners, Supabase makes modularity a priority.
-
-## Architecture
-
-- `Database`
- - [PostgreSQL](https://www.postgresql.org/) is an object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
- - Coonection Pooling: [PgBouncer](https://www.pgbouncer.org/) is a lightweight connection pooler for PostgreSQL.
- - [postgres-meta](https://github.com/supabase/postgres-meta) is a RESTful API for managing your Postgres, allowing you to fetch tables, add roles, and run queries, etc.
-- `Auth`
- - Authentication: [GoTrue](https://github.com/supabase/gotrue) is an SWT based API for managing users and issuing SWT tokens.
- - Authorization: using [PostgreSQL Row Level Security](https://supabase.com/docs/guides/auth/row-level-security).
-- `APIs`
- - Websockets: [Realtime](https://github.com/supabase/realtime) is an Elixir server that allows you to listen to PostgreSQL inserts, updates, and deletes using websockets. Realtime polls Postgres' built-in replication functionality for database changes, converts changes to JSON, then broadcasts the JSON over websockets to authorized clients.
- - REST: [PostgREST](http://postgrest.org/) is a web server that turns your PostgreSQL database directly into a RESTful API
- - GraphQL: [pg_graphql](https://github.com/supabase/pg_graphql) adds GraphQL support to your PostgreSQL database.
- - Edge Functions: [Deno](https://deno.land/) is a modern and secure runtime for JavaScript, TypeScript, and WebAssembly.
- - Reverse Proxy: [Kong](https://github.com/Kong/kong) is a cloud-native API gateway.
-- `File Storage`
- - [Storage](https://github.com/supabase/storage-api) provides a RESTful interface for managing Files stored in S3, using Postgres to manage permissions.
-
-## Open source
-
-Each part of the Supabase ecosystem is open source. Wherever possible, we support existing tools rather than developing from scratch.
-
-We choose tools which are [OSI Compliant](https://opensource.org/licenses), with a strong bias towards MIT, Apache 2.0, and PostgreSQL licenses.
-Everything we open source is licensed with one of these 3 licenses:
-
-- MIT for client libraries
-- Apache 2.0 for API servers
-- PostgreSQL for any Postgres-related tooling
-
-## Client Libraries
-
-Supabase provides client libraries for building your products. Our approach for client libraries is modular. Each sub-library is a standalone implementation for a single system.
-
-For example, our `supabase-js` library is a wrapper around five smaller libraries:
-
-- `postgrest-js` (REST API)
-- `gotrue-js` (Authentication)
-- `storage-js` (File Storage)
-- `realtime-js` (Websockets)
-- `functions-js` (Edge Functions)
-
-## Community
-
-Supabase officially supports the Javascript libraries, and all other libraries are community-maintained. This is one way that we try to support and foster an open source ecosystem.
-
-
+Guides here
\ No newline at end of file
diff --git a/apps/reference/docs/reference.md b/apps/reference/docs/reference.md
new file mode 100644
index 00000000000..2a58264af54
--- /dev/null
+++ b/apps/reference/docs/reference.md
@@ -0,0 +1,465 @@
+---
+id: reference
+sidebar_label: About
+---
+
+# Reference Documentation
+
+This section of the docs provides technical descriptions of the products and how to use them.
+
+## Modularity
+
+Supabase is modular. While it may seem like a single tool, it is actually a suite of tools that are composed on top of a PostgreSQL database. This offers several advantages:
+
+- Each tool scales independently.
+- Each tool can be self-hosted.
+- Developers can disable tools which are not required.
+- Each tool is focused on a single task to minimize complexity.
+
+This is a similar approach to any Enterprise-grade system with an additional focus on modularity: while some companies might cut-corners, Supabase makes modularity a priority.
+
+## Architecture
+
+- `Database`
+ - [PostgreSQL](https://www.postgresql.org/) is an object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
+ - Coonection Pooling: [PgBouncer](https://www.pgbouncer.org/) is a lightweight connection pooler for PostgreSQL.
+ - [postgres-meta](https://github.com/supabase/postgres-meta) is a RESTful API for managing your Postgres, allowing you to fetch tables, add roles, and run queries, etc.
+- `Auth`
+ - Authentication: [GoTrue](https://github.com/supabase/gotrue) is an SWT based API for managing users and issuing SWT tokens.
+ - Authorization: using [PostgreSQL Row Level Security](https://supabase.com/docs/guides/auth/row-level-security).
+- `APIs`
+ - Websockets: [Realtime](https://github.com/supabase/realtime) is an Elixir server that allows you to listen to PostgreSQL inserts, updates, and deletes using websockets. Realtime polls Postgres' built-in replication functionality for database changes, converts changes to JSON, then broadcasts the JSON over websockets to authorized clients.
+ - REST: [PostgREST](http://postgrest.org/) is a web server that turns your PostgreSQL database directly into a RESTful API
+ - GraphQL: [pg_graphql](https://github.com/supabase/pg_graphql) adds GraphQL support to your PostgreSQL database.
+ - Edge Functions: [Deno](https://deno.land/) is a modern and secure runtime for JavaScript, TypeScript, and WebAssembly.
+ - Reverse Proxy: [Kong](https://github.com/Kong/kong) is a cloud-native API gateway.
+- `File Storage`
+ - [Storage](https://github.com/supabase/storage-api) provides a RESTful interface for managing Files stored in S3, using Postgres to manage permissions.
+
+## Open source
+
+Each part of the Supabase ecosystem is open source. Wherever possible, we support existing tools rather than developing from scratch.
+
+We choose tools which are [OSI Compliant](https://opensource.org/licenses), with a strong bias towards MIT, Apache 2.0, and PostgreSQL licenses.
+Everything we open source is licensed with one of these 3 licenses:
+
+- MIT for client libraries
+- Apache 2.0 for API servers
+- PostgreSQL for any Postgres-related tooling
+
+## Client Libraries
+
+Supabase provides client libraries for building your products. Our approach for client libraries is modular. Each sub-library is a standalone implementation for a single system.
+
+For example, our `supabase-js` library is a wrapper around five smaller libraries:
+
+- `postgrest-js` (REST API)
+- `gotrue-js` (Authentication)
+- `storage-js` (File Storage)
+- `realtime-js` (Websockets)
+- `functions-js` (Edge Functions)
+
+## Community
+
+Supabase officially supports the Javascript libraries, and all other libraries are community-maintained. This is one way that we try to support and foster an open source ecosystem.
+
+