-
-
Notifications
You must be signed in to change notification settings - Fork 315
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
how nix works: reword introduction #840
Conversation
hopefully this is closer to an order of practical importance
summarize each feature into an overview, finish with a set of practical capabilities. use more general terms that hopefully make sense without more detailed explanation.
Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
@fricklerhandwerk Would you be interested in bigger rewrite of this page? |
@garbas Yes, I have more material in the making, and really I don't want to leave that page in such an inconsistent state. |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-30/19112/1 |
Could this PR be merged into #841 content wise. I think the content of both PRs could be a provide a nice opening. |
do not introduce "build result" without prior definition, this appears to confuse uninitiated readers. there is no space to define it, so leave it out. restructure second paragraph to uniformly capture which features directly follow from complete, exact dependencies.
2a00a68
to
3a2f6bb
Compare
this is more in line with going top-down in level of detail
the diagram is produced with mermaid, but currently there is no machinery to render that directly. therefore only the SVG.
as requested by @garbas to make it part of the introduction
the diagram is only there for a distant future where we can render it directly. using dotted lines does not change meaning, but lets us keep it for reference.
3a2f6bb
to
eb43214
Compare
this term is overloaded with operating system concepts, and it is enough to say that the store facilitates the build system properties.
@garbas Could we merge this? Further documentation work will produce more updates to the feature sections eventually. Otherwise this PR will hang around for more weeks. |
1 similar comment
@garbas Could we merge this? Further documentation work will produce more updates to the feature sections eventually. Otherwise this PR will hang around for more weeks. |
Should we mere this? Let's not let the perfect be the enemy of the good. |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/user-study-learning-journey-1/21398/1 |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/usability-study-session-2/21400/1 |
Closing this since that work continues on the Nix manual. Maybe we can include that section on the web site once it's good enough. |
This is fallout from documenting nix architecture, especially regarding a more general terminology which is hopefully more friendly to beginners.
I have more additions in the pipeline, and the feature sections could still use some love to add more detail to and stay consistent with the introduction, as well as getting more well-structured internally.
@garbas @thufschmitt @Ericson2314 @Radvendii