isle/docs/dev/rebuilding-documentation.md

# Rebuilding Documentation

Most documentation for Isle 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:

```bash
cd docs
nix-shell
```

The resulting artifact changes should be committed to the repository alongside
the source changes.
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`# Rebuilding Documentation`

Perform all in-code renames which don't affect actual functionality 2023-08-05 21:53:17 +00:00			Most documentation for Isle takes the form of markdown (`.md`) files,
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`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:`

More documentation updates, notably filling out firewall configuration 2024-12-18 20:54:15 +00:00			```bash
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`cd docs`
			`nix-shell`
			```

			`The resulting artifact changes should be committed to the repository alongside`
			`the source changes.`