[Bug 267428] FDP primer: Writing style: corrections to indents/levels et cetera

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=267428

Graham Perrin <grahamperrin@freebsd.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|DUPLICATE                   |---
           Keywords|                            |needs-patch, needs-qa
             Status|Closed                      |Open

--- Comment #3 from Graham Perrin <grahamperrin@freebsd.org> ---
On closer inspection, this is not entirely a duplicate. 

Re <https://docs-archive.freebsd.org/doc/>, something went wrong between: 

a)
<https://docs-archive.freebsd.org/doc/13.0-RELEASE/usr/local/share/doc/freebsd/en_US.ISO8859-1/books/fdp-primer/writing-style-guide.html>
   where Acronyms was ― correctly ― a subsection within the 
   Style Guide section of the Writing Style chapter

b)
<https://docs-archive.freebsd.org/doc/12.3-RELEASE/usr/local/share/doc/freebsd/en/books/fdp-primer/book.html#writing-style-guide>
   where One sentence per line should have been a subsection, it was 
   added as a section

– I have not yet found the relevant commit.
<https://github.com/freebsd/freebsd-doc/blob/8ffacca1e165396444c40c773a9e297d22abb5bf/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml#L258-L282>
before the migration of doc to Hugo/AsciiDoctor appears to be OK, at a glance.

In the current edition of the book,
<https://docs.freebsd.org/en/books/fdp-primer/writing-style/#writing-style-guide>
is a section that asks readers to "follow these style conventions." and then: 

* no convention. 

Acronyms should not be a section, it should be a subsection (a convention); and
so on. 

<https://web.archive.org/web/20250307191600/https://docs.freebsd.org/en/books/fdp-primer/writing-style/>
is the most recent capture of the chapter.

-- 
You are receiving this mail because:
You are the assignee for the bug.