-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Add some form of Nix Language reference #7259
Comments
Yes! |
Had a similar question on Stackoverflow almost exactly 2 years ago, and it looks like that the authoritative and most complete reference is the lexer file itself, and the slightly outdated chapter "4. The Nix Expression Language" in Eelco Dolstra's PhD thesis from 2006 - none of which are ideal. |
There is actually also this part of the nix manual: here is the link for the stable release: |
@Narice please see my original comment, I know that documentation exists in some form, it just is not enough to work with due to it’s fragmentation across the Nix and Nixpkgs manuals. That, and the reference of Nixpkgs.lib lacks any form of navigation and hence fails as a reference quickly navigated. |
Oh I see, so what you would like is a Nix language reference which also contain a reference of the standard nixpkgs library? |
@Narice @enderger @toraritte feel free to ping me or get in touch Discourse. I will try to help with any effort improving documentation. |
Would this be covered by NixOS/nix.dev#267? |
The tutorial is not a reference. The manual is still incomplete in various subtle ways, so while this issue is very broad, it is in principle still valid, and will be for some time. |
Introduce your stance
Currently, the documentation for the Nix Language is scattered across several manuals, with the main library functions in a non-searchable layout separate from the bultins.
Describe the issue
Currently, the reference material for the Nix Language is scattered across the manuals in a strongly inconvenient way. The language needs it's own documentation, preferably in the style of Clojuredocs and the Rust Documentation.
Additional context
I am currently working on a Nix-based project and have found the language's documentation hard to navigate and use.
The text was updated successfully, but these errors were encountered: