A sketch of architectural ideas in how to make the cardano-node more modular and approachable.

Check it out

The report is written using markdown and can be viewed via the Github rendering here or built into a HTML using nix:

nix build .#book

To open the result navigate your browser to result/index.html

Alternatively, you would need to have a mdbook, as well as the relevant preprocessors (see buildInputs in flake.nix) to produce the same output in build/ with:

mdbook build

We do use mdbook so with the tools installed or inside a nix develop shell, you can live preview the result with:

mdbook serve --open

See the mdbook manual or github flavored markdown for more information on what is available for editing.