Setting up a feedback loop
$ cd smos-docs-site $ nix-shell ../shell.nix nix-shell $ ./scripts/devel.sh
Contributing an screencast to the documentation site involves writing an
autorecorder cast specification.
This ensures that the casts are always showing the current version of the tools that they show off.
Locate the cast spec files in
Copy the example cast:
example.yamlto create your new
Make the changes that you want.
Try out your cast using
autorecorder record mycast.yaml mycast.cast.
Use your cast in the documentation site by embedding it like this:
<asciinema-player src="/casts/mycast.cast" autoplay="true" preloop="true" loop="true"> </asciinema-player>
Contributing to the NixOS Module Docs
Building the NixOS module docs requires a nix build, so they are not built in the default feedback loop for
If you want to work on them from the
stack feedback loop anyway, you can build the module docs with
nix-build nix/pkgs.nix -A moduleDocs and then set
MODULE_DOCS=result/share/doc/nixos/options.json before running the feedback loop:
Note that you may have to
stack clean smos-docs-site to get the build to pick up this change.