doc: update links, extend instructions on one-sentence-one-line (#470965)

This commit is contained in:
Johannes Kirschbauer
2025-12-16 10:04:14 +00:00
committed by GitHub
4 changed files with 7 additions and 17 deletions
+4
View File
@@ -213,6 +213,10 @@ Put each sentence in its own line.
This makes reviews and suggestions much easier, since GitHub's review system is based on lines.
It also helps identifying long sentences at a glance.
Not everything has been migrated to this format yet.
Please always use it for new content.
When changing existing content, update formatting if possible, but avoid excessive diffs.
### Writing Function Documentation
Function documentation is *reference documentation*, for which
@@ -1,11 +1,3 @@
# Contributing to Nixpkgs documentation {#chap-contributing}
This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md).
## devmode {#sec-contributing-devmode}
This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md).
## Syntax {#sec-contributing-markup}
This section has been moved to [doc/README.md](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md).
+2 -6
View File
@@ -4663,12 +4663,8 @@
"index.html#reviewing-contributions--merging-pull-requests"
],
"chap-contributing": [
"index.html#chap-contributing"
],
"sec-contributing-devmode": [
"index.html#sec-contributing-devmode"
],
"sec-contributing-markup": [
"index.html#chap-contributing",
"index.html#sec-contributing-devmode",
"index.html#sec-contributing-markup"
],
"part-interoperability": [
@@ -1,7 +1,7 @@
# Contributing to this manual {#chap-contributing}
The sources of the NixOS manual are in the [nixos/doc/manual](https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual) subdirectory of the [Nixpkgs](https://github.com/NixOS/nixpkgs) repository.
This manual uses the [Nixpkgs manual syntax](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup).
This manual uses the [Nixpkgs manual syntax](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#syntax) and [stylistic conventions](https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#documentation-conventions).
You can quickly check your edits with the following:
@@ -13,8 +13,6 @@ $ nix-build nixos/release.nix -A manual.x86_64-linux
If the build succeeds, the manual will be in `./result/share/doc/nixos/index.html`.
There's also [a convenient development daemon](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-devmode).
The above instructions don't deal with the appendix of available `configuration.nix` options, and the manual pages related to NixOS. These are built, and written in a different location and in a different format, as explained in the next sections.
## Development environment {#sec-contributing-development-env}