Skip to content

Commit 3c6e3a9

Browse files
authored
Update DEVELOPERS.md (supabase#34143)
improve punctuation and readability
1 parent 1721017 commit 3c6e3a9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

DEVELOPERS.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To contribute code to [Supabase](https://supabase.com), you must fork the [Supab
6565

6666
### Install dependencies
6767

68-
1. Install the dependencies in the root of the repo.
68+
1. Install the dependencies in the root of the repo:
6969

7070
```sh
7171
pnpm install # install dependencies
@@ -77,7 +77,7 @@ To contribute code to [Supabase](https://supabase.com), you must fork the [Supab
7777
cp apps/www/.env.local.example apps/www/.env.local
7878
```
7979

80-
3. After that you can run the apps simultaneously with the following.
80+
3. After that you can run the apps simultaneously with the following:
8181
```sh
8282
pnpm dev # start all the applications
8383
```
@@ -117,8 +117,8 @@ Installing a package in a specific workspace requires you to move to the workspa
117117

118118
For example:
119119

120-
1. `cd apps/studio`: move to the `studio` workspace
121-
2. `pnpm add react`: installs `react` into `studio` workspace
120+
1. `cd apps/studio`: move to the `studio` workspace.
121+
2. `pnpm add react`: installs `react` into `studio` workspace.
122122

123123

124124
---
@@ -145,7 +145,7 @@ First, make sure you have the Docker installed on your device. You can download
145145
cp .env.example .env
146146
```
147147

148-
3. Run docker
148+
3. Run docker:
149149

150150
```sh
151151
docker compose up
@@ -186,9 +186,9 @@ Create a new entry in the [`redirects.js`](https://github.com/supabase/supabase/
186186
We support "federating" docs, meaning doc content can come directly from external repos other than [`supabase/supabase`](https://github.com/supabase/supabase).
187187

188188
- It's great for things like client libs who have their own set of docs that we don't want to duplicate on the official Supabase docs (eg. [`supabase/vecs`](https://github.com/supabase/vecs)).
189-
- No duplication or manual steps required - fetches and generates automatically as part of the docs build pipeline
190-
- It's flexible - you can "embed" external docs nearly anywhere at any level in Supabase docs, but they will feel native
191-
- If you are maintaining a repo containing docs that you think could also live in Supabase docs, feel free to create an issue and we can work together to integrate
189+
- No duplication or manual steps required - fetches and generates automatically as part of the docs build pipeline.
190+
- It's flexible - you can "embed" external docs nearly anywhere at any level in Supabase docs, but they will feel native.
191+
- If you are maintaining a repo containing docs that you think could also live in Supabase docs, feel free to create an issue and we can work together to integrate.
192192

193193
Federated docs work using Next.js's build pipeline. We use `getStaticProps()` to fetch remote documentation (ie. markdown) at build time which is processed and passed to the respective page within the docs.
194194

0 commit comments

Comments
 (0)