From 308ca19afa39d0c8023b549ae76b7142298ccc8a Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Mon, 15 Dec 2025 09:49:35 +0100 Subject: [PATCH] doc: add note on updating existing content to one-sentence-one-line --- doc/README.md | 4 ++++ nixos/doc/manual/contributing-to-this-manual.chapter.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 889198bc9e35..6ac3edc8af62 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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 diff --git a/nixos/doc/manual/contributing-to-this-manual.chapter.md b/nixos/doc/manual/contributing-to-this-manual.chapter.md index 778e707a1396..bf8aea99efef 100644 --- a/nixos/doc/manual/contributing-to-this-manual.chapter.md +++ b/nixos/doc/manual/contributing-to-this-manual.chapter.md @@ -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://github.com/NixOS/nixpkgs/blob/master/doc/README.md#syntax). +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: