nix icon indicating copy to clipboard operation
nix copied to clipboard

refactor rendering command documentation to markdown

Open fricklerhandwerk opened this issue 3 years ago • 2 comments

idea:

  • make document structure visible, like in a template
  • separate processing from formatting (structure/content vs. presentation)
  • order functions by descending abstraction
  • use self-explanatory names
  • avoid broadly scoped or deeply nested let bindings

this allows readers to enter the code starting with what is visible from the outside, instead of working themselves up from purely technical details.

fricklerhandwerk avatar Aug 27 '22 01:08 fricklerhandwerk

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/flakes-and-remote-repos-not-being-updated/21580/15

nixos-discourse avatar Sep 10 '22 11:09 nixos-discourse

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/tweag-nix-dev-update-35/21701/1

nixos-discourse avatar Sep 15 '22 09:09 nixos-discourse