From bc10eed3ffb6f53ebcfcf70bdcf3ba6f52ed4492 Mon Sep 17 00:00:00 2001 From: "A. David Thyresson" Date: Sat, 22 Jan 2022 16:40:33 -0500 Subject: [PATCH] Clarify build and make steps for new docs --- web/README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/web/README.md b/web/README.md index 4ba49f53420..1a49a3f9ab0 100644 --- a/web/README.md +++ b/web/README.md @@ -5,7 +5,16 @@ - `cd /web/spec/` - run `npm install` - run `make` which will pull the latest TSDoc with your updates -- add your comments to `supabase.yml` | `dart.yml` | `postgrest.yml` | `gotrue.yml` | `realtime.yml` + +> Note: `make` requires [`jq - a lightweight and flexible command-line JSON processor`](https://stedolan.github.io/jq/). To install on OSX with homebrew, run: `brew install jq`. + +- Add your comments to `supabase.yml` | `dart.yml` | `postgrest.yml` | `gotrue.yml` | `realtime.yml` + +> If adding a new reference: +> Be sure to add the `.mdx` with the documentation to `web/docs/reference/` such as `web/docs/reference/javascript/auth-api-createuser.mdx` + +> If needed, add to the sidebars using the reference defined in the document `.mdx` frontmatter, such as: `id: auth-api-createuser` + - run `npm run gen:supabase` inside the `/spec` folder which will generate the Docusaurus pages - run `npm run build` to make sure the build is working -- submit your PR +- Submit your PR