Documentation team

Part of: NixOS

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

## 1. 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. 
 
## 1. 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](https://github.com/hsjobeki/Documentation-page-count-estimate)

## 2. Goal: Page splitting in nixos-render-docs (nrd)

nixos-render-docs (nrd) will be extended to produce separate Markdown files, each suitable for consumption by the tooling in nix.dev

including making the new content visible in https://docs.nixos.org

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

## 4. 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-buildershttps://docs.nixos.org/nixpkgs/stable/build-helpers

Estimated Monthly Budget
€169
Today's Balance
€2,782.38
Navigation & redirects
€35,000

Budget


Transparent and open finances.

+€1.07EUR
Completed
Contribution #964570
+€5.00EUR
Completed
Contribution #944279
+€5.00EUR
Completed
Contribution #924987
Today’s balance

€2,782.38 EUR

Total raised

€24,527.39 EUR

Total disbursed

€21,745.01 EUR

Estimated annual budget

€2,032.07 EUR

Contribute


Become a financial contributor.

Financial Contributions

Custom contribution
Donation
Make a custom one-time or recurring contribution.

Latest activity by


+ 81

Documentation team is all of us

Our contributors 86

Thank you for supporting Documentation team.

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:...
Read more
Published on September 7, 2024 by Valentin Gagarin