isle/docs/dev/rebuilding-documentation.md

15 lines
435 B
Markdown
Raw Normal View History

# Rebuilding Documentation
Most documentation for cryptic-net takes the form of markdown (`.md`) files,
which do not require any build step. There are a few other kinds of files, such
as `.plantuml` files, which do require a build step. If these are changed then
their artifacts should be rebuilt by doing:
```
cd docs
nix-shell
```
The resulting artifact changes should be committed to the repository alongside
the source changes.