Skip to content

Commit 61b3ff0

Browse files
committed
docs: Update instruction for docfx
1 parent eb23ca9 commit 61b3ff0

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

docs/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,17 @@ These sample components, source files, and tests source files are included in th
2121
The following chapter describes how you can run and view the documentation locally
2222

2323
### Requirements
24-
You will need the following tool installed:
24+
The following tools are required to build and view the documentation locally:
2525
* The [`dotnet serve` tool](https://github.com/natemcmaster/dotnet-serve)
26+
* The `docfx` dotnet global tool: `dotnet tool install -g docfx`.
2627
* [DocFx](https://dotnet.github.io/docfx/tutorial/docfx_getting_started).
2728

2829
### View the documentation
2930

30-
1. Build the `bunit.sln` solution in the root folder.
31-
2. From `docs/site` run `dotnet build`. If you get warnings from running `dotnet build`, try running it again.
32-
3. Inside `docs/site` run `dotnet run` to start the generation.
33-
4. From `docs/` run `serve-docs.cmd`. This will start up a local web server, hosting the generated documentation site.
31+
1. Build the `bunit.sln` solution in the root folder in release configuration `dotnet build -c Release`.
32+
2. From `docs/site` run `docfx metadata` to generate the documentation site's metadata.
33+
3. After that run `docfx build` to generate the documentation site.
34+
4. From `docs/` run `serve-docs.cmd`. This will start up a local web server (using `dotnet serve`), hosting the generated documentation site.
3435
5. After changing samples from `docs/samples`, run `dotnet test`. This will compile the sample components and run the sample tests.
3536

3637
## Documentation Writing Rules

0 commit comments

Comments
 (0)