doc: point manual contributing guides to devmode's README (#411326)
There's quite a bit of pingpong redirection with Nixpkgs and NixOS manual utilities. Since devmode was lacking a README, the descriptive text is moved there and it's referenced by both manuals.
This commit is contained in:
committed by
GitHub
parent
8c35c2b446
commit
60264c48e9
@@ -56,11 +56,7 @@ Make sure that your local files aren't added to Git history by adding the follow
|
|||||||
|
|
||||||
#### `devmode`
|
#### `devmode`
|
||||||
|
|
||||||
The shell in the manual source directory makes available a command, `devmode`.
|
Use [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview when editing the manual.
|
||||||
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
|
|
||||||
|
|
||||||
### Testing redirects
|
### Testing redirects
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,9 @@ Make sure that your local files aren't added to Git history by adding the follow
|
|||||||
/**/.direnv
|
/**/.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}
|
## Testing redirects {#sec-contributing-redirects}
|
||||||
|
|
||||||
|
|||||||
@@ -95,6 +95,9 @@
|
|||||||
"sec-contributing-development-env": [
|
"sec-contributing-development-env": [
|
||||||
"index.html#sec-contributing-development-env"
|
"index.html#sec-contributing-development-env"
|
||||||
],
|
],
|
||||||
|
"sec-contributing-devmode": [
|
||||||
|
"index.html#sec-contributing-devmode"
|
||||||
|
],
|
||||||
"sec-mattermost": [
|
"sec-mattermost": [
|
||||||
"index.html#sec-mattermost"
|
"index.html#sec-mattermost"
|
||||||
],
|
],
|
||||||
|
|||||||
6
pkgs/by-name/de/devmode/README.md
Normal file
6
pkgs/by-name/de/devmode/README.md
Normal file
@@ -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
|
||||||
Reference in New Issue
Block a user