Documentation team update
Current status
Maintenance mode: we answer to pings @NixOS/documentation-team typically within 24-48h but currently don’t actively develop notable projects or systematically review PRs. New people interested in rebooting the team are welcome!
People
-
@hsjobeki and @fricklerhandwerk are responsive
-
We may want to update the team list on nixos.org
@henrik-ch @yuki_is_bored @proofconstruction @alejandrosame @danielsidhion @djacu feel free to answer the scream test for membership
Blockers or challenges
-
Funding for continuous team leadership/administration ran out in May 2024, barely any activity since
-
Content structuring such as
- Moving reference docs into doc-comments
- Refactoring/writing doc-comments and markdown content
- Splitting/reifying content between nix.dev, and the manuals
-
Developing a strategy for maintaining technical infrastructure
-
Need maintainers for nixdoc and nixos-render-docs
Upcoming topics or projects
- @hsjobeki is slowly working on improving documentation rendering infrastructure
- @fricklerhandwerk wants to rethink information architecture to improve discoverability, experimenting with @erictapen on NGIpkgs
- Also slowly nudging towards splitting the Nixpkgs and NixOS manuals
- @hsjobeki wants to make moves towards common sense about content/markdown extensions across the ecosystem.
- Nothing more concrete planned at the moment due to lack of time to commit for (even leading, and certainly implementing) larger projects, reflected in how long it took to write this update.
Budget
- We manage our own Open Collective project under the NixOS collective and strongly recommend other teams to do the same
- Recently didn’t find time to update contents for a new fundraiser, but should do it as one of our next tasks
- Anyone interested in implementing a funded project start to finish, please talk to @fricklerhandwerk for setting it up