From d0169b96fbe8340d4f8d0b9cece6512a4565a779 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Thu, 18 Jun 2026 12:07:47 +0200 Subject: [PATCH] docs/readme: reword 'devmode' -> Live preview --- doc/README.md | 6 ++++-- nixos/doc/manual/contributing-to-this-manual.chapter.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/README.md b/doc/README.md index 4fafb9f575b8..0f5b3d2b77d4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -54,9 +54,11 @@ Make sure that your local files aren't added to Git history by adding the follow /**/.direnv ``` -#### `devmode` +#### Live preview -Use [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview when editing the manual. +Run [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview while editing the manual: it rebuilds on every change and reloads the page in your browser automatically. + +Changes to the renderer 'pkgs/by-name/ni/nixos-render-docs' need a manual restart. Run: `devmode` again. ### Testing redirects diff --git a/nixos/doc/manual/contributing-to-this-manual.chapter.md b/nixos/doc/manual/contributing-to-this-manual.chapter.md index 19549c32f277..a98ce7fc9923 100644 --- a/nixos/doc/manual/contributing-to-this-manual.chapter.md +++ b/nixos/doc/manual/contributing-to-this-manual.chapter.md @@ -35,9 +35,11 @@ Make sure that your local files aren't added to Git history by adding the follow /**/.direnv ``` -### `devmode` {#sec-contributing-devmode} +### Live preview {#sec-contributing-devmode} -Use [`devmode`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/de/devmode/README.md) for a live preview when editing the manual. +Run [`devmode`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/de/devmode/README.md) for a live preview while editing the manual: it rebuilds on every change and reloads the page in your browser automatically. + +Changes to the renderer 'pkgs/by-name/ni/nixos-render-docs' need a manual restart. Run: `devmode` again. ## Testing redirects {#sec-contributing-redirects}