New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README: improve development docs #3840
Conversation
Maybe we can link to the development section in the manual instead? Duplicating the same info in multiple places doesn't seem ideal. |
The manual that I found is for the released version of nix. We cannot put it there because is no flakes yet. Is there a link to the latest build of the manual? Otherwise I would suggest to remove the hacking guide from the manual and bundle with the source instead. It does not make sense to point users to out-of-date guides. |
There is https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download-by-type/doc/manual#chap-hacking. Once we convert to Markdown we can link to the manual directly on GitHub... |
830aa39
to
aa4de74
Compare
Great improvement. But when I try to hack something, I don't want to open my web browser. So I would prefer it in the readme, even if then it is duplicated. This enables me to just cat README.md, and then start hacking. |
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
Well, it seems like we change to some other document format soonish. Also docbook is supposed to be a plaintext format too. |
Fair enough. Then maybe add a path to the file in the readme? So you can find it directly with cat. |
It will be replaced once the conversion happens. |
No description provided.