diff --git a/docs/readme.md b/docs/readme.md index 623134a144..6d89c8deaf 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -17,28 +17,35 @@ expected. ## Serving the documentation locally -To serve up the documentation locally, you need to run the script +To serve up the documentation locally, you need to run the following +commands: ```shell +./build.ps1 -Stage build -Target PrepareBuild +./build.ps1 -Stage build -Target Build ./build.ps1 -Stage docs -Target PreviewDocs ``` ### On Windows -On Windows, you need to run the following build command in a PowerShell +On Windows, you need to run the following commands in a PowerShell terminal: ```shell +./build.ps1 -Stage build -Target PrepareBuild +./build.ps1 -Stage build -Target Build ./build.ps1 -Stage docs -Target PreviewDocs ``` ### On Unix First you need to [install PowerShell on macOS][ps-mac] or [Linux][ps-linux], -then execute the following command: +then execute the following commands: ```shell -pwsh ./build.ps1 -Stage docs -Target PreviewDocs +./build.ps1 -Stage build -Target PrepareBuild +./build.ps1 -Stage build -Target Build +./build.ps1 -Stage docs -Target PreviewDocs ``` After pressing enter, the documentation will be generated and then served under