Skip to content

Commit

Permalink
Fix broken link and update installation instructions
Browse files Browse the repository at this point in the history
- Fixed invalid GitHub actions URL by removing extra slash.
- Improved clarity in the setup steps.
- Minor formatting adjustments for better readability.
  • Loading branch information
sergeypanin1994 committed Feb 8, 2025
1 parent 8d05119 commit f28149e
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
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.

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

## Installation

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

```sh
curl -fsSL https://get.pnpm.io/install.sh | sh -
curl -fsSL https://get.pnpm.io/install.sh | sh -
```

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

## Install deps

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

```sh
pnpm add node-gyp -g
```

Then, run:

```sh
pnpm install
```
Expand All @@ -58,31 +60,31 @@ pnpm install

> Note: PLEASE SEE `apps/nextra/README.md` for more details!
0. Setup environment
1. Setup environment

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.

To ensure you have the right setup, you can run
To ensure you have the right setup, you can run:

```sh
pnpm prebuild
```

1. Build Nextra
2. Build Nextra

```bash
npx turbo run build --filter={apps/nextra}...
```

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

2. Navigate to the correct subdirectory
3. Navigate to the correct subdirectory

```sh
cd apps/nextra
```

3. Run the development server
4. Run the development server

```sh
pnpm dev
Expand All @@ -98,9 +100,9 @@ pnpm fmt

## Regenerating contributors

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

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:
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:

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

```sh
pnpm contributors
```
```

0 comments on commit f28149e

Please sign in to comment.