From nobody Sat Apr 19 19:52:10 2025 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Zg2Mv0lSGz5tP30 for ; Sat, 19 Apr 2025 19:52:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Zg2Mt615fz3JL2; Sat, 19 Apr 2025 19:52:10 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745092330; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=5mkPh1b1effvl/L74vMvdzxjkc3DHdb1sLAafhISFuc=; b=vq5BUD5NIEdkB/EqFN1olluq1ovUDg02ani5n4KD0YDr9L4rSFfxaDlEEyXSVAsEGkasli oknkNt2DLewGk6j8cHL03t8LMcT7hnePGcbdQLWzj0UJipJCcu0pGSBxVO3LbF4d04f6rb ErqQjUHle7yHkFPaBdIhBLamfV+NREgaMEhgFfGyVavOC6Es13uk1Me5d3EklnwQ20FI/u GpPBsQAvXMcl5rTkcwIRKpBH73pZlpgoxd4F8/8peNNHVnDBuw/qWQYSnvJBdCBM8SY7OS OhLByu4vKyGMc2D5IAJtYfd1x3YkbO+dpWKpN4KhlK+n3VqAzwyuJ0OXryFwVQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1745092330; a=rsa-sha256; cv=none; b=p+lmsYEJ0tR43dS7O0s+OE4rkFMzFqdo+9FhEp6OODL89srEvnjZXxtyeT6ZAUS1niKm1A 9+s0MCmD683UKZGSijkq3eDmMYFii+9E7SweoggvpRlFhQBN/uwlosO4X8QZCLuWunmGoe lHDlvxLQgfkIXGpPaxZeo3xOBctJA6yUgXpb20B9GEcrxgXQ9kJFI7NXna5O/ovkvSPpRi y28FtoHGo1iBY0081JiyuX4laLNaHXjjyRN69rmrpIhhnG/xyeZUYWXZPZp5/Cn7+ByzaN 5pE1kea6poKe9ChOqkZSnHZrqVjAcQE7hmX5V9k5eVjA01NZ6O6P42ylOeG2Kw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1745092330; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=5mkPh1b1effvl/L74vMvdzxjkc3DHdb1sLAafhISFuc=; b=h5E6AL34JuiUrNkF5UC81WR9lcrF2d0VDzjjzhDdLKNnjqWMChuL3gft0q3JXIX+ea049B C6sc5UqqZRRxSgdK42NJ5WQ0vitRTuSb8JwuPjdXrHAFCMcUCFnz0XnNHFHO0ox+6sKg7Z 2o5O6a+GkE+8kBvTAyO9ZcYnjWP8TyL9sS6QoB+W5zRl3bXDiw5kdRlUjmxSmyUa0gOtLa RtM+c3EPxqEkXwHXgS0ZQixexxH52gfZ68pbi+PFLLspYBYIM1ZaYG7SPLJE7+vy9yFrTY 7sGmabekpj4tunFeKOlz9nHMhjpMe8hl4/QJdf5ieSrLh4mrpCbbsz6UICTYHg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Zg2Mt5LbnzYsf; Sat, 19 Apr 2025 19:52:10 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 53JJqAvc083598; Sat, 19 Apr 2025 19:52:10 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 53JJqAMw083595; Sat, 19 Apr 2025 19:52:10 GMT (envelope-from git) Date: Sat, 19 Apr 2025 19:52:10 GMT Message-Id: <202504191952.53JJqAMw083595@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Alexander Ziaee Subject: git: 77ba8a6555 - main - fdp/writing-style: Improve subsections List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 77ba8a655507ac707d111c800f84d5138d0fa841 Auto-Submitted: auto-generated The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/doc/commit/?id=77ba8a655507ac707d111c800f84d5138d0fa841 commit 77ba8a655507ac707d111c800f84d5138d0fa841 Author: Alexander Ziaee AuthorDate: 2025-03-29 17:16:09 +0000 Commit: Alexander Ziaee CommitDate: 2025-04-19 19:48:54 +0000 fdp/writing-style: Improve subsections PR: 267428 Reviewed by: carlavilla, fernape, Jim Brown Approved by: carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D49567 --- documentation/content/en/books/fdp-primer/writing-style/_index.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index 1ade058e60..965998b9eb 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -14,7 +14,7 @@ params: = Writing Style :doctype: book :toc: macro -:toclevels: 1 +:toclevels: 2 :icons: font :sectnums: :sectnumlevels: 6 @@ -169,7 +169,7 @@ For more information about writing style, see http://www.bartleby.com/141/[Eleme To keep the source for the documentation consistent when many different people are editing it, please follow these style conventions. [[one-sentence-per-line]] -== One sentence per line +=== One sentence per line Use Semantic Line Breaks in the documentation, a technique called "one sentence per line". The idea of this technique is to help the users to write and read documentation. @@ -189,7 +189,7 @@ They are endowed with reason and conscience and should act towards one another i .... [[writing-style-acronyms]] -== Acronyms +=== Acronyms Acronyms should be defined the first time they appear in a document, as in: "Network Time Protocol (NTP)". After the acronym has been defined, use the acronym alone unless it makes more sense contextually to use the whole term.