From 4721072f4e710c844144d2d9951a841d86b4251d Mon Sep 17 00:00:00 2001 From: alex p Date: Thu, 1 Oct 2026 10:19:25 +0200 Subject: [PATCH] doc/readme: simplify mention to `nixos-render-docs` --- doc/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 59692f090531..540e84cd11a5 100644 --- a/doc/README.md +++ b/doc/README.md @@ -35,7 +35,7 @@ See [Document structure](#document-structure) for a structural template. ## Building and navigating documentation locally -The Nixpkgs manual is rendered by [nixos-render-docs](../pkgs/by-name/ni/nixos-render-docs/) (sometimes abbreviated `nrd`). +The Nixpkgs manual is rendered by [`nixos-render-docs`](../pkgs/by-name/ni/nixos-render-docs/). Its index is [`nav.json`](./nav.json). @@ -52,7 +52,7 @@ $ nix-shell Within the developer environment, run [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview while editing the manual. -Changes to the renderer `pkgs/by-name/ni/nixos-render-docs` need a manual restart: run `devmode` again. +If the `nixos-render-docs` source-code changes, `devmode` must be restarted. ### Building the docs