Skip to content

Commit 77ae087

Browse files
authored
chore(docs): Minor fixes on local documentation development workflows (#7684)
1 parent 6eaea18 commit 77ae087

File tree

2 files changed

+27
-12
lines changed

2 files changed

+27
-12
lines changed

docs/README.md

+26-11
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,28 @@ Check out the contributing guide [here](../CONTRIBUTING.md).
1515

1616
### Installation
1717

18-
This project requires recent versions of rust and cargo to be installed.
18+
This project requires recent versions of Rust and Cargo to be installed.
1919
Any build errors should indicate dependencies that need installing, and at what version.
2020

21-
On the root folder of the repository, run:
21+
From the _noir_ root directory, run:
2222

23-
```
23+
```sh
2424
yarn
25-
yarn build
2625
```
2726

2827
### Local Development
2928

30-
```
31-
yarn workspace docs version
32-
```
29+
From the _noir_ root directory:
3330

34-
This command fetches and compiles the list of documentation versions to build with.
31+
1. Fetch and generate the list of recent stable documentation versions to build:
3532

33+
```sh
34+
yarn workspace docs version::stables
3635
```
36+
37+
2. Start a development server serving docs preview:
38+
39+
```sh
3740
yarn workspace docs dev
3841
```
3942

@@ -42,13 +45,25 @@ reflected live without having to restart the server.
4245

4346
### Build
4447

48+
From the _noir_ root directory:
49+
50+
1. Fetch and generate the list of recent stable documentation versions to build:
51+
52+
```sh
53+
yarn workspace docs version::stables
4554
```
55+
56+
2. Build the docs:
57+
58+
```sh
4659
yarn workspace docs build
4760
```
4861

49-
This command generates static content into the `build` directory and can be served using any static
50-
contents hosting service. You can see a preview by running:
62+
This command generates static content into the _build_ directory and can be served using any static
63+
contents hosting service.
5164

52-
```
65+
3. Verify build by serve a preview of the docs locally:
66+
67+
```sh
5368
yarn workspace docs serve
5469
```

docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"preprocess": "yarn workspace @noir-lang/acvm_js build && ./scripts/codegen_nargo_reference.sh && yarn node ./scripts/preprocess/index.js",
77
"dev": "yarn preprocess && ENV=dev docusaurus start",
88
"build": "yarn preprocess && docusaurus build",
9-
"clean": "rm -rf ./processed-docs ./processed-docs ./build",
9+
"clean": "rm -rf ./processed-docs ./processed-docs-cache ./build",
1010
"version::stables": "ts-node ./scripts/setStable.ts",
1111
"serve": "serve build",
1212
"swizzle": "docusaurus swizzle",

0 commit comments

Comments
 (0)