Skip to content

Commit 71565e8

Browse files
committed
Update commands needed to build docs
1 parent 59a2861 commit 71565e8

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

docs/readme.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,36 @@ expected.
1717

1818
## Serving the documentation locally
1919

20-
To serve up the documentation locally, you need to run the `build.ps1` script
21-
with the arguments `-Target Preview-Documentation`.
20+
To serve up the documentation locally, you need to run the following
21+
commands:
22+
23+
```shell
24+
./build.ps1 -Stage build -Target PrepareBuild
25+
./build.ps1 -Stage build -Target Build
26+
./build.ps1 -Stage docs -Target PreviewDocs
27+
```
2228

2329
### On Windows
2430

25-
On Windows, you need to run the following build command in a PowerShell
31+
On Windows, you need to run the following commands in a PowerShell
2632
terminal:
2733

2834
```shell
29-
.\build.ps1 -Target Preview-Documentation
35+
./build.ps1 -Stage build -Target PrepareBuild
36+
./build.ps1 -Stage build -Target Build
37+
./build.ps1 -Stage docs -Target PreviewDocs
3038
```
3139

3240
### On Unix
3341

3442
First you need to [install PowerShell on macOS][ps-mac] or [Linux][ps-linux],
35-
then execute the following command:
43+
then execute the following commands:
3644

3745
```shell
38-
pwsh build.ps1 -Target Preview-Documentation
39-
```
46+
./build.ps1 -Stage build -Target PrepareBuild
47+
./build.ps1 -Stage build -Target Build
48+
./build.ps1 -Stage docs -Target PreviewDocs
49+
```
4050

4151
After pressing enter, the documentation will be generated and then served under
4252
a local web server. Information about the URL that can be used to view the docs

0 commit comments

Comments
 (0)