News
- The latest documentation team report summarises our activities between October 2022 and March 2023.
- @fricklerhandwerk started offering regular documentation office hours. Anyone can join to ask questions, get pull requests reviewed, or work together on improving documentation.
- @Janik wrote an application to Google Season of Docs 2024 on behalf of the NixOS Foundation, and @DMills27 wrote a call for proposals. We did not get the grant, but took the opportunity to narrow down our priorities for writing tutorials after analysing traffic and search requests: creating Docker images and cross compilation.
- The transition to stable URLs for the Nix reference manual is now complete. @infinisil has helped a great deal with settting up the infrastructure for rendering and automatic updates. The last step was to redirect links from nixos.org to nix.dev – thanks to @roberth for sitting down together at the Zurich 24.05 ZHF hackathon. There was a temporary disruption that was mitigated thanks to the quick reaction of @avocadoom, @garbas, @jtojnar, and @hexa.
- @olaf left the documentation team. Thank you very much for your patient support over the past two years! @olaf wrote the NixOS VM and NixOS VM testing articles, who help hundreds of nix.dev visitors every month.
- @djacu started porting his module system tutorial, which he presented at NixCon North America 2024, to nix.dev as incremental improvements to the current module system deep dive.
How you can help
If you like what we’re doing, consider joining the documentation team or donating to the NixOS Foundation’s documentation project on Open Collective to fund ongoing maintenance and development of learning materials and other documentation.
Get in touch
Check the Nix documentation team page for information on how to get in touch. Write us or drop into the office hours if you’d like to get things done together!
Recent changes
This is a list of all recent changes made to documentation in the Nix ecosystem.
NixOS/nix
- #10785 fix typos (@mjoerg)
- #10779 print type and value in “flake attr is not a derivation” errors (@Mic92)
- #10755 add examples of comments in the Nix language (@fricklerhandwerk)
-
#10734 nix3-build: show all FOD errors with
--keep-going(@Mic92) - #10729 fix typo in testing documentation (@fidgetingbits)
- #10722 Content addressing store objects (@Ericson2314)
-
#10718 reword
nix-envdocumentation (@wamirez) -
#10715 redirect “Copying Closures via SSH” guide to
nix-copy-closure(@fricklerhandwerk) - #10714 add cross-references for discoverability (@fricklerhandwerk)
-
#10713 reword documentation on
nix-store --export(@fricklerhandwerk) -
#10712 reword documentation on
nix-store --import(@fricklerhandwerk) -
#10711 make a more relevant example for
nix-store --export(@fricklerhandwerk) -
#10710 add example to
nix-store --import(@fricklerhandwerk) -
#10709 reword documentation on
nix-copy-closure(@fricklerhandwerk) -
#10708 expand example on
nix-copy-closure(@fricklerhandwerk) - #10703 remove link to relocated manual page (@fricklerhandwerk)
- #10701 Warn on unknown settings when the first positional is an argument (@cole-h)
- #10698 Revert “manual: fold sidebar sections” (@fricklerhandwerk)
- #10691 Rename commit-lockfile-summary to commit-lock-file-summary for consistency (@grahamc)
- #10589 streamline macOS uninstall instructions (@fricklerhandwerk)
- #10563 doc/glossary: Add base directory (@roberth)
- #10560 Improve path value documentation (@roberth)
- #10550 Make a few commands that were Unix-only no longer (@Ericson2314)
NixOS/nixpkgs
- #316056 doc: fix testers.testEqualContents fragment link (@tie)
- #316026 doc/release-notes: highlight desktop environment updates (@wegank)
- #315908 nixos/stalwart-mail: rocksdb as default storage (@pacien)
- #315387 Release note tweaks (@jacg)
- #313891 doc: improve the look of terms in definition lists (@DanielSidhion)
- #313733 doc/release-notes: update codename (@wegank)
- #313730 doc/release-notes: more release note edits (@jacg)
- #313538 nixos/release-notes: sort, cleanup (@wegank)
- #313473 nixos/filesender: init (@thenhnn)
- #313466 oink: init at 1.1.1 (@jtbx)
- #313408 doc: autogenerate python interpreter table (@alejandrosame)
- #313146 Add nextjs ollama llm UI frontend for Ollama (@malteneuss)
-
#312693 [Backport release-23.11] Add
types.attrTag(@roberth) - #312618 nixos/rl-2405: fix typo in chromium DRM change entry (@bjornfor)
- #312518 bluemap: init at 3.21, and init module (@dali99)
-
#311902 doc: clarify consequences of
lib.meta.setName(@wamirez) - #311692 k3s: k3s_1_29 → k3s_1_30 (@superherointj)
- #311608 flarum: init at 1.8.1, module (@fsagbuya)
- #311414 maintainers/team-list: Set GitHub team for docs team (@infinisil)
- #311318 doc: Fix nixos download page links (@toadjaune)
- #311299 pkgs/formats: add generator for PHP config files (@thenhnn)
NixOS/nix-pills
- #244 replace unoffical wiki links with offical ones (@jopejoe1)
- #238 Update 09-automatic-runtime-dependencies.md - fix NixOps link (@noamraph)
- #237 Update 07-working-derivation.md - “input derivations” → “input sources” (@noamraph)
- #236 preface: Remove mention of root prompt (@jtojnar)
-
#235 07-working-derivation.md: use
derivationinstead ofmkDerivation(@noamraph) - #233 Convert from docbook to mdbook (@noamraph)
- #232 treewide: Format all Nix code according to RFC-166 (@dasJ)
NixOS/nix.dev
- #988 proxy development version of the Nix manual (@fricklerhandwerk)
- #987 update contributing instructions (@fricklerhandwerk)
- #983 Remove olaf from documentation team (@olafklingt)
- #982 Add first lesson for the new module tutorials. (@djacu)
- #980 update Nix manuals (@fricklerhandwerk)
- #979 Fix typos (@fricklerhandwerk)
- #978 Minor team doc improvements (@infinisil)
- #976 add information on office hours (@fricklerhandwerk)
-
#974
libunused binding in hello.nix (@stablejoy) - #973 Fix Typos (@manuth)
- #972 fix syntax error (@stablejoy)
- #970 add names to vale (@olafklingt)
- #969 Linkcolor (@olafklingt)
- #968 Minor improvements (@pdietl)
-
#967 best-practices: add a new tip for
rec(@AndersonTorres) - #965 replace unoffical wiki links with offical ones (@jopejoe1)
- #963 highlight background of collapsed texts (@olafklingt)
- #962 Update CODEOWNERS (@olafklingt)
- #961 Fix typo (@michaelshmitty)
- #960 refactor: rename test.nix to default.nix for consistency (@Sajesty)
- #959 Update accept.txt (@olafklingt)
- #958 update cross compiling tutorial to 23.11 (@olafklingt)
- #957 split out a page for documentation resources (@fricklerhandwerk)
- #956 deduplicate CONTRIBUTING.md (@fricklerhandwerk)
- #955 Improve Documentation: Exclude Prompt Characters from Copied Shell Commands (@andylizf)
- #954 correct the number of flake users (@Mic92)
- #952 add google season of docs 2024 propsal (@Janik-Haag)
- #951 point wiki links to official wiki (@JulienMalka)
- #950 add google season of docs 2024 propsal (@Janik-Haag)
- #949 clarify wording on channel branches (@fricklerhandwerk)
New tracking issues
- #301574 Rename “Nix” to “Nix language” when it refers to the language
- #966 Expand and improve the Module System tutorial
Accepted RFCs
-
#166 [RFC 0166] Nix formatting, take two (@piegamesde)
While not strictly related to documentation, @piegames and @infinisil concluded the technical discussion and strategic decision-making on formatting Nix language code in Nixpkgs, and are currently working on refining the implementation. Standardisation of formatting can be expected to reduce the total overhead of making code contributions, and also reduce the effort required for writing code style guides.