Clarify build and make steps for new docs

This commit is contained in:
A. David Thyresson committed 2022-01-22 16:40:33 -05:00
1 parent 5573f8b493
commit bc10eed3ff
1 file changed
+11 -2
+11 -2
View File
@@ -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