Skip to content

Commit 482a995

Browse files
erbiercHiDeoo
andauthored
docs: update CONTRIBUTING.md to clarify development environment setup (#3495)
Co-authored-by: HiDeoo <[email protected]>
1 parent 2953c4e commit 482a995

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This repo is a “monorepo,” meaning it contains several projects in one. It c
3838

3939
### Setting up a development environment
4040

41-
You can [develop locally](#developing-locally) or use an online coding development environment like [GitHub Codespaces](#developing-using-github-codespaces) or [Gitpod](#developing-using-gitpod) to get started quickly.
41+
You can [develop locally](#developing-locally) or use an online coding development environment like [GitHub Codespaces](#developing-using-github-codespaces) to get started quickly.
4242

4343
#### Developing locally
4444

@@ -64,23 +64,24 @@ You can [develop locally](#developing-locally) or use an online coding developme
6464
pnpm i
6565
```
6666

67-
#### Developing using Gitpod
68-
69-
**Prerequisites:** Developing Starlight using Gitpod requires a free [Gitpod account](https://gitpod.io).
70-
71-
1. **Open the Gitpod URL** [https://gitpod.io/#https://github.com/withastro/starlight](https://gitpod.io/#https://github.com/withastro/starlight). You can alternatively install a [Gitpod browser extension](https://www.gitpod.io/docs/configure/user-settings/browser-extension) which will add a "Gitpod" button when viewing [Starlight's repo on GitHub](https://github.com/withastro/starlight).
72-
73-
2. **Install dependencies** with `pnpm`:
67+
5. **Generate TypeScript types** for all Astro modules:
7468

7569
```sh
76-
pnpm i
70+
cd docs
71+
pnpm astro sync
7772
```
7873

7974
#### Developing using GitHub Codespaces
8075

8176
1. **Create a new codespace** via https://codespaces.new/withastro/starlight
8277

83-
2. If running the docs site, pass the `--host` flag to avoid “502 Bad Gateway” errors:
78+
2. **Generate TypeScript types** for all Astro modules:
79+
80+
```sh
81+
pnpm astro sync
82+
```
83+
84+
3. If running the docs site, pass the `--host` flag to avoid “502 Bad Gateway” errors:
8485

8586
```sh
8687
cd docs

0 commit comments

Comments
 (0)