2023-07-20 Documentation team meeting notes #65

Agenda

  • updates
  • reviews

Notes

Nixpkgs manual: Don't render Contributing section · Issue #244056 · NixOS/nixpkgs · GitHub

  • See issue for arguments
  • @mightyiam: Could only render contributing guidelines in unstable manual
    • @infinisil: Hard to implement, doesn’t feel proper
  • @zmitchell: Agrees to remove it from the manual, avoid duplication
  • Nobody against, @infinisil will implement that

Nix doc tests

Eval example

nix-repl> singleton "test"
[ "test" ]
expr='singleton "test"'
expectedResult='[ "test" ]'
output=$(nix-instantiate --eval --strict --expr ...)
if [[ expectedResult != output ]];
  exit ...
fi

NixOS example

{
  systemPackages = ...;
}
nix-instantiate <nixpkgs/nixos> --arg configuration <file>

nixpkgs/NixOS manuals: devmode feature by mightyiam · Pull Request #243062 · NixOS/nixpkgs · GitHub needs reviews

  • Add feedback should be addressed
  • @roberth can review it asynchronously

Migrate "Nix-representable formats" to Nixpkgs manual · Issue #251040 · NixOS/nixpkgs · GitHub

add a tutorial on packaging existing software by proofconstruction · Pull Request #650 · NixOS/nix.dev · GitHub