
Documentation team
Owns the standards, tooling, and processes that keep NixOS documentation reliable.
About
Nix rewards those who already know it. We're changing that.
Finding answers in Nix often means reading source code, asking the right person, or stumbling across a forum post from three years ago. Your donation funds the tooling, review processes, and standards that make that unnecessary.
Read the detailed vision
Finding answers in Nix often means reading source code, asking the right person, or stumbling across a forum post from three years ago. Your donation funds the tooling, review processes, and standards that make that unnecessary.
Read the detailed vision
1. Monthly Goal: Paid documentation Maintainer
Budget for paid documentation housekeeping.
- Write new content
- Test & keep existing content up-to-date
- Handle day to day documentation tasks, review PRs, collect frequently asked questions and turn them into content.
2. One time Goal: Framework evaluation
Before committing to a rendering approach, we need to choose a path and validate it. The two candidate strategies are:
Hybrid: render ~5k pages statically, with the remaining 150k+ records produced via server-side generation (on demand).
Fully static: render all 155k+ pages statically.
The evaluation will compare these against build time, dev-cycle time, and the docs-writing experience (DX).
This goal comes first because its outcome determines everything else: whether it's worth extending the existing Sphinx setup, or whether nix.dev needs a different rendering framework altogether.
See Documentation-page-count-estimate
3. One time Goal: Prepare docs.nixos.org cutover
nixos-render-docs (nrd) will be extended so that the nix.dev tooling can consume sources directly. This is what brings the existing manual content (Nix, Nixpkgs, NixOS) onto the new portal at https://docs.nixos.org as first-class pages.
We build up the new portal in parallel while keeping the current manuals and bring it to content parity with what's served today.
Note: Redirects from the old URLs come deliberately last (as go-live). We prepare everything we can in the earlier goals.
4. One time Goal: Continuous deployment & Reduce feedback times
Improve the infrastructure so that documentation changes deploy automatically: every documentation-changing PR gains a preview, and the master branch and PRs deploy without manual intervention.
Problem today: every deployment is blocked by three gates, the channel must pick up the change, the channel itself must be non-broken, and a flake-input bump PR must land in the separate nixos-homepage repository
5. One time Goal: Navigation & redirects
Once docs.nixos.org is serving stable URLs visitors to old URLs should be redirected to their new equivalents. For example:
https://nixos.org/manual/nixpkgs/stable/#part-builders → https://docs.nixos.org/nixpkgs/stable/build-helpers
Estimated Monthly Budget
€206
Today's Balance
€3,042.15
Navigation & redirects
€35,000
Budget
Transparent and open finances.
Credit from Guest to Documentation team •
+€4.00EUR
Completed
Contribution #966354
Credit from squarepear to Documentation team •
+€50.00EUR
Completed
Contribution #966463
+€5.00EUR
Completed
Contribution #966269
€
Today’s balance€3,042.15 EUR
Total raised
€24,787.16 EUR
Total disbursed
€21,745.01 EUR
Estimated annual budget
€2,466.07 EUR
Contribute
Become a financial contributor.
Financial Contributions
Documentation team is all of us
Our contributors 92
Thank you for supporting Documentation team.
hsjobeki
Admin
flox
€5,000 EUR
Anduril Indus...
€5,000 EUR
Amjad Masad
€5,000 EUR
Sam Griffin
€1,950 EUR
Channable
€1,150 EUR
Adam K
€1,000 EUR
Contria GmbH
€535 EUR
Gerd Flaig
€500 EUR
Contria Connect
€500 EUR
fidgetingbits
€340 EUR
Simon Wolf
€310 EUR
Connect
Let’s get the ball rolling!
News from Documentation team
Updates on our activities and progress.
New tutorials: Remote deployments, caching, distributed builds
Thanks to your support, we added three new tutorials, written for nix.dev by Jacek Galowicz from Nixcademy:...
Published on September 7, 2024 by Valentin Gagarin