Happy Docsgiving 🦃

Announcements
28

Update

First of all, thank you to everyone who is providing feedback and help on these efforts, we are making great progress!

You can help the DocBook to CommonMark conversion efforts by grabbing one of the new todo issues in the project!

Nixpkgs Manual

Since the last update, I did the following:

  • finished converting all the last doc/functions sections
  • updated nixdoc to output CommonMark
  • converted all the top-level chapters to CommonMark
  • fixed the graphviz graph

All this work is available at doc: add nixpkgs manual split into multiple pages by ryantm · Pull Request #108063 · NixOS/nixpkgs · GitHub and there is a live demo.

Work left to do:

  1. Improve mmdoc styling to make it acceptable for use
  2. Update NixOS website to work with the new rendering system

NixOS Manual

We’re starting to convert the NixOS manual too and you can help out by grabbing one of the new todo issues in the project!

  • @blaggacao started us off by converting all the release notes to CommonMark!
  • I made a script you can use to review PRs for nixos conversion changes:
#! /usr/bin/env nix-shell
#! nix-shell -i bash -p git meld gitAndTools.gh
set -eou pipefail

trap "kill 0" SIGINT SIGTERM EXIT

PR="$1"

gh pr checkout "$PR"
MB="$(git merge-base HEAD master)"

nix-build nixos/release.nix -A manual.x86_64-linux
CONVERTED_MAN="$(readlink result)"

git checkout master

nix-build nixos/release.nix -A manual.x86_64-linux
MB_MAN="$(readlink result)"

nix-shell -p python3 --run "python3 -m http.server 8000 --directory $MB_MAN/share/doc/nixos" &
nix-shell -p python3 --run "python3 -m http.server 8001 --directory $CONVERTED_MAN/share/doc/nixos" &

sleep 2

"$BROWSER" localhost:8000/
"$BROWSER" localhost:8001/

meld "$MB_MAN/share/doc/nixos/" "$CONVERTED_MAN/share/doc/nixos/" &

sleep 5
read -r -p "Press enter to exit."

Thank you once again for your help and support!

9 Likes