search

cachix / devenv

Fast, Declarative, Reproducible, and Composable Developer Environments
https://devenv.sh
Apache License 2.0
3.56k stars 259 forks source link

`man` pages? #1108

Open znd4 opened 1 month ago

znd4 commented 1 month ago

Obviously this would be a lot of work, so this isn't a demand, but I'm curious if you'd be open to someone adding a manpage (e.g. man 5 devenv.nix) for devenv.nix? I'm not sure if there's a best practice to have a man 5 devenv.yaml, but I'm assuming that people will be able to mentally translate without too much work.

I don't know if building a man file will be as simple as pandoc ... existing_docs.md, but I'd love to try to get something like that working in package.nix

domenkozar commented 1 month ago

It shouldn't be that much work to do, see https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/default.nix#L199