diff --git a/doc/README.md b/doc/README.md index 029db7eabc7f..bcd9ffd63550 100644 --- a/doc/README.md +++ b/doc/README.md @@ -56,11 +56,7 @@ Make sure that your local files aren't added to Git history by adding the follow #### `devmode` -The shell in the manual source directory makes available a command, `devmode`. -It is a daemon, that: -1. watches the manual's source for changes and when they occur — rebuilds -2. HTTP serves the manual, injecting a script that triggers reload on changes -3. opens the manual in the default browser +Use [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview when editing the manual. ### 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 a78a136becca..1b296918f9e2 100644 --- a/nixos/doc/manual/contributing-to-this-manual.chapter.md +++ b/nixos/doc/manual/contributing-to-this-manual.chapter.md @@ -37,7 +37,9 @@ Make sure that your local files aren't added to Git history by adding the follow /**/.direnv ``` -You might want to also use [`devmode`](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#devmode) while editing the manual. +### `devmode` {#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. ## Testing redirects {#sec-contributing-redirects} diff --git a/nixos/doc/manual/redirects.json b/nixos/doc/manual/redirects.json index 5970010e9e64..fe19534a82e4 100644 --- a/nixos/doc/manual/redirects.json +++ b/nixos/doc/manual/redirects.json @@ -95,6 +95,9 @@ "sec-contributing-development-env": [ "index.html#sec-contributing-development-env" ], + "sec-contributing-devmode": [ + "index.html#sec-contributing-devmode" + ], "sec-mattermost": [ "index.html#sec-mattermost" ], diff --git a/pkgs/by-name/de/devmode/README.md b/pkgs/by-name/de/devmode/README.md new file mode 100644 index 000000000000..506474769004 --- /dev/null +++ b/pkgs/by-name/de/devmode/README.md @@ -0,0 +1,6 @@ +# `devmode` + +`devmode` is a daemon, that: +1. watches the manual's source for changes and when they occur — rebuilds +2. HTTP serves the manual, injecting a script that triggers reload on changes +3. opens the manual in the default browser