From c52cb56a45286ae823b253f1566411c864f6b468 Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Sat, 24 Sep 2022 22:00:33 +0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: dng --- DEVELOPERS.md | 2 +- apps/reference/DEVELOPERS.md | 15 +++++++-------- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 9d9d428ba7b..35e435952e1 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -97,7 +97,7 @@ The monorepo has a set of shared components under `/packages`: #### Installing packages -Installing a package with NPM workspaces requires you to add the `-w` flag to tell NPM which workspace you want to install into. +Installing a package with NPM workspaces requires you to add the `-w` flag to tell NPM which workspace you want to install into. Do not install dependencies in their local folder, install them from the route using the `-w` flag. The format is: `npm install -w=`. diff --git a/apps/reference/DEVELOPERS.md b/apps/reference/DEVELOPERS.md index 9002b525f22..27630b4d569 100644 --- a/apps/reference/DEVELOPERS.md +++ b/apps/reference/DEVELOPERS.md @@ -42,11 +42,10 @@ To contribute code to Supabase, you must fork the [Supabase Repository](https:// cd supabase ``` -### Running docs +### Run the docs locally -We'll be running the [Supabase Docs](https://supabase.com/docs) -1. Build development server +1. Build the development server npm @@ -60,7 +59,7 @@ We'll be running the [Supabase Docs](https://supabase.com/docs) yarn build ``` -1. Start development server +1. Start the development server npm @@ -78,13 +77,13 @@ We'll be running the [Supabase Docs](https://supabase.com/docs) --- -### Which files to edit? +### Editing files -Our docs site are comprised of guides, tutorials, quickstarts as well as reference docs. It's important to note that these reference docs (located at https://supabase.com/docs/reference) are generated from spec files. +Our docs site are comprised of guides, tutorials, quickstarts, and reference docs. Note that the [reference docs](https://supabase.com/docs/reference) are generated from spec files. -If you go to any page in the [https://supabase.com/docs](Supabase Docs), you'll see an `Edit this page` link at the bottom. This link will indicate which file you need to edit. +If you go to any page in the [Supabase docs](https://supabase.com/docs), you'll see an **Edit this page** link at the bottom. This link indicates which file you need to edit. -The [https://supabase.com/docs/guides/with-nextjs](NextJS Quickstart), for example, is a markdown file that you can edit directly. This [https://supabase.com/docs/reference/javascript/auth-signup](supabase-js reference doc), however, is generated from a [https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml](spec file). +For example, the [NextJS Quickstart](https://supabase.com/docs/guides/with-nextjs) is a markdown file you can edit directly. However, this [signUp() reference doc](https://supabase.com/docs/reference/javascript/auth-signup) is generated from a [spec file](https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml). ## Create a pull request