Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsjobeki merged 3 commits into from
Dec 16, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ab2a5d
doc: collapse old contributing sections to one redirect
fricklerhandwerk Dec 15, 2025
2d66ed0
nixos/doc: don't link to Nixpkgs devmode guide
fricklerhandwerk Dec 15, 2025
308ca19
doc: add note on updating existing content to one-sentence-one-line
fricklerhandwerk Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions doc/contributing/contributing-to-documentation.chapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
8 changes: 2 additions & 6 deletions doc/redirects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
4 changes: 1 addition & 3 deletions nixos/doc/manual/contributing-to-this-manual.chapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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}
Expand Down
Loading