Skip to content

Commit b47dcec

Browse files
authored
docs: Clarify and organize the dev setup guide (#716)
1 parent 1ae49f5 commit b47dcec

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

docs/src/content/docs/guides/setup.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,38 @@ It also helps to have some basic familiarity with the command line, Git, HTML, C
2828

2929
Click the "Fork" button on the top right of the [`namesake` repository](https://github.com/namesakefyi/namesake/) to create your own copy of the repository.
3030

31+
<details>
32+
<summary>Why do I have to do this?</summary>
33+
The `namesakefyi/namesake` repository only allows people on the Namesake core team to create new branches and push changes. In order to propose changes, **you need to make edits on your _own_ copy** ("fork") of the repository. Once you've made your changes, you propose merging them back into the main repository with a **pull request**.
34+
</details>
35+
3136
2. Clone your fork.
3237

38+
Open your terminal and paste this line (updating `MY_USERNAME` to your own GitHub username), then press `enter` to run it:
39+
3340
```shell
3441
git clone https://github.com/MY_USERNAME/namesake.git
3542
```
3643

3744
</Steps>
3845

39-
You should now have a `namesake` folder on your computer.
46+
You should now have a `namesake` folder on your computer. Open the folder in your code editor and take a look around!
4047

4148
## Start the development server
4249

4350
<Steps>
4451

45-
1. From the `namesake` directory, install packages.
52+
1. Navigate to the `namesake` directory from your terminal, then install packages.
4653

4754
```bash
55+
cd namesake
4856
pnpm install
4957
```
5058

51-
:::tip{icon="pnpm"}
52-
If you get **`error command not found: pnpm`**, [make sure pnpm is installed](https://pnpm.io/installation).
53-
:::
59+
<details>
60+
<summary>I'm getting `error command not found: pnpm`</summary>
61+
You need to install `pnpm`, the package manager we use. Follow the `pnpm` [installation guide](https://pnpm.io/installation). If you get stuck, reach out on Discord!
62+
</details>
5463

5564
If this is your first time installing packages, it may take awhile to download everything.
5665

@@ -66,7 +75,7 @@ You should now have a `namesake` folder on your computer.
6675

6776
</Steps>
6877

69-
You should now be able to see the Namesake website at [http://localhost:4321](http://localhost:4321)! Changes will automatically refresh in your browser as you make edits to the code.
78+
You should now be able to see the Namesake website at [http://localhost:4321](http://localhost:4321)! Changes will automatically refresh in your browser as you edit and save the code.
7079

7180
Leave this process running in the background while you work on the codebase. To stop the server, press `Ctrl + C` in the terminal.
7281

0 commit comments

Comments
 (0)