Skip to content

Commit f28149e

Browse files
Fix broken link and update installation instructions
- Fixed invalid GitHub actions URL by removing extra slash. - Improved clarity in the setup steps. - Minor formatting adjustments for better readability.
1 parent 8d05119 commit f28149e

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
We now use [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to check for broken links in the GitHub Markdown. We use a corresponding link checker for pages on Aptos.dev.
1515

1616
With results visible at:
17-
https://github.com//aptos-labs/developer-docs/actions/workflows/links.yml
17+
[https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)
1818

1919
## Installation
2020

@@ -33,7 +33,7 @@ brew install node
3333
- Install the latest [pnpm](https://pnpm.io/installation) by executing the below command on your Terminal:
3434

3535
```sh
36-
curl -fsSL https://get.pnpm.io/install.sh | sh -
36+
curl -fsSL https://get.pnpm.io/install.sh | sh -
3737
```
3838

3939
## Clone the Developer docs repo
@@ -44,12 +44,14 @@ git clone https://github.com/aptos-labs/developer-docs.git
4444

4545
## Install deps
4646

47-
You may have to run the following command first if you are on macOS M1 Sonoma or newer
47+
You may have to run the following command first if you are on macOS M1 Sonoma or newer:
4848

4949
```sh
5050
pnpm add node-gyp -g
5151
```
5252

53+
Then, run:
54+
5355
```sh
5456
pnpm install
5557
```
@@ -58,31 +60,31 @@ pnpm install
5860

5961
> Note: PLEASE SEE `apps/nextra/README.md` for more details!
6062
61-
0. Setup environment
63+
1. Setup environment
6264

6365
Ensure you have configured your `.env` properly under `apps/nextra/.env`. There is a `.env.example` there that you can duplicate and rename to `.env` for simplicity.
6466

65-
To ensure you have the right setup, you can run
67+
To ensure you have the right setup, you can run:
6668

6769
```sh
6870
pnpm prebuild
6971
```
7072

71-
1. Build Nextra
73+
2. Build Nextra
7274

7375
```bash
7476
npx turbo run build --filter={apps/nextra}...
7577
```
7678

7779
This will build `apps/nextra` and all local packages it depends on.
7880

79-
2. Navigate to the correct subdirectory
81+
3. Navigate to the correct subdirectory
8082

8183
```sh
8284
cd apps/nextra
8385
```
8486

85-
3. Run the development server
87+
4. Run the development server
8688

8789
```sh
8890
pnpm dev
@@ -98,9 +100,9 @@ pnpm fmt
98100

99101
## Regenerating contributors
100102

101-
The src/contributors.json file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
103+
The `src/contributors.json` file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
102104

103-
In order to generate the contributor map you must authenticate with GitHub. The best way to do that is using GitHub CLI [installation guide](https://github.com/cli/cli#installation). Once you have the GitHub CLI installed, you can run the following command to authenticate:
105+
In order to generate the contributor map, you must authenticate with GitHub. The best way to do that is using GitHub CLI [installation guide](https://github.com/cli/cli#installation). Once you have the GitHub CLI installed, you can run the following command to authenticate:
104106

105107
```sh
106108
gh auth login --scopes read:user,user:email
@@ -110,4 +112,4 @@ Once that is done, you can generate the map with this command:
110112

111113
```sh
112114
pnpm contributors
113-
```
115+
```

0 commit comments

Comments
 (0)