Skip to content
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

Merged
merged 2 commits into from Jul 21, 2020
Merged

README: improve development docs #3840

merged 2 commits into from Jul 21, 2020

Conversation

Mic92
Copy link
Member

@Mic92 Mic92 commented Jul 20, 2020

No description provided.

@edolstra
Copy link
Member

Maybe we can link to the development section in the manual instead? Duplicating the same info in multiple places doesn't seem ideal.

@Mic92
Copy link
Member Author

Mic92 commented Jul 20, 2020

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.

@edolstra
Copy link
Member

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...

@Mic92 Mic92 force-pushed the docs branch 2 times, most recently from 830aa39 to aa4de74 Compare July 20, 2020 14:12
doc/manual/hacking.xml Outdated Show resolved Hide resolved
doc/manual/hacking.xml Outdated Show resolved Hide resolved
doc/manual/hacking.xml Outdated Show resolved Hide resolved
@Kloenk
Copy link
Member

Kloenk commented Jul 20, 2020

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>
@Mic92
Copy link
Member Author

Mic92 commented Jul 20, 2020

Well, it seems like we change to some other document format soonish. Also docbook is supposed to be a plaintext format too.

@Kloenk
Copy link
Member

Kloenk commented Jul 20, 2020

Well, it seems like we change to some other document format at some point. 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.

@Mic92
Copy link
Member Author

Mic92 commented Jul 20, 2020

Well, it seems like we change to some other document format at some point. 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.

@edolstra edolstra merged commit 7e91cdd into NixOS:master Jul 21, 2020
@Mic92 Mic92 deleted the docs branch July 22, 2020 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants