Hello.NPlant

An example on Continuous Documentation - introducing a feedback loop for documentation as part of your build. This example shows how you can generate

• full blown documentation using mkdocs
• architectural documentation that lives with your code using NPlant & plantuml
• UI sketches & prototypes for use cases with Salt

Install

You will need

• plantuml, install by

choco install plantuml

• mkdocs, install by

choco install python -y
pip install --user -r requirements.txt

Build documentation

Build the documentation using

dotnet run --project hello.nplant/hello.nplant.csproj

The documentation is built into the \site subdirectory. Best way to view is

python -m mkdocs serve

and browse to http://localhost:8000. Note that changes in the markdown documentation files within \docs are automatically tracked by mkdocs rebuilding & refreshing the served documentation.