Sources for the user manual 📖.
The user-manual is built using Docusaurus 2, which combines React components and markdown into a customisable static website. Docusaurus supports a set of plugins and basic features (coming in the form of 'presets'). We use it to create the actual user manual (docs), documenting our architectural decision records, a custom page for the API reference, and various other documentation pages around the Hydra Head protocol.
$ yarn$ yarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
Note that this will have quite some broken links as we are referring to
generated documentation, test data and benchmarks. To put these artifacts at the
right place before, you can use these nix builds from the repository root:
nix build .#spec && ln -s $(readlink result)/hydra-spec.pdf docs/static/hydra-spec.pdf
nix build .#haddocks -o docs/static/haddock
(cd hydra-node; nix develop .#hydra-node-bench --command tx-cost --output-directory $(pwd)/../docs/benchmarks)
(cd hydra-cluster; nix develop .#hydra-cluster-bench --command bench-e2e --scaling-factor 1 --output-directory $(pwd)/../docs/benchmarks)While we supported and encouraged contributing translations in the past, we turned off internationalization features as translations inevitably became out-of-date and on-demand translation of website became significantly better with AI language models. Nontheless, if you feel like we should offer translated pages and want to contribute that, please don't hesitate to file an issue.