@@ -15,25 +15,28 @@ Check out the contributing guide [here](../CONTRIBUTING.md).
15
15
16
16
### Installation
17
17
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.
19
19
Any build errors should indicate dependencies that need installing, and at what version.
20
20
21
- On the root folder of the repository , run:
21
+ From the _ noir _ root directory , run:
22
22
23
- ```
23
+ ``` sh
24
24
yarn
25
- yarn build
26
25
```
27
26
28
27
### Local Development
29
28
30
- ```
31
- yarn workspace docs version
32
- ```
29
+ From the _ noir_ root directory:
33
30
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:
35
32
33
+ ``` sh
34
+ yarn workspace docs version::stables
36
35
```
36
+
37
+ 2 . Start a development server serving docs preview:
38
+
39
+ ``` sh
37
40
yarn workspace docs dev
38
41
```
39
42
@@ -42,13 +45,25 @@ reflected live without having to restart the server.
42
45
43
46
### Build
44
47
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
45
54
```
55
+
56
+ 2 . Build the docs:
57
+
58
+ ``` sh
46
59
yarn workspace docs build
47
60
```
48
61
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.
51
64
52
- ```
65
+ 3 . Verify build by serve a preview of the docs locally:
66
+
67
+ ``` sh
53
68
yarn workspace docs serve
54
69
```
0 commit comments