Date: Sat, 19 Apr 2025 19:52:10 GMT From: Alexander Ziaee <ziaee@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 77ba8a6555 - main - fdp/writing-style: Improve subsections Message-ID: <202504191952.53JJqAMw083595@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/doc/commit/?id=77ba8a655507ac707d111c800f84d5138d0fa841 commit 77ba8a655507ac707d111c800f84d5138d0fa841 Author: Alexander Ziaee <ziaee@FreeBSD.org> AuthorDate: 2025-03-29 17:16:09 +0000 Commit: Alexander Ziaee <ziaee@FreeBSD.org> CommitDate: 2025-04-19 19:48:54 +0000 fdp/writing-style: Improve subsections PR: 267428 Reviewed by: carlavilla, fernape, Jim Brown <jpb@jimby.name> 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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202504191952.53JJqAMw083595>