Page MenuHomeFreeBSD

fdp-primer: reduce confusion around section levels
Needs ReviewPublic

Authored by grahamperrin on Nov 30 2022, 5:04 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Sep 25, 7:44 PM
Unknown Object (File)
Wed, Sep 3, 12:55 PM
Unknown Object (File)
Wed, Sep 3, 12:14 PM
Unknown Object (File)
Jul 28 2025, 10:23 AM
Unknown Object (File)
Jun 21 2025, 1:01 AM
Unknown Object (File)
Jun 15 2025, 8:00 PM
Unknown Object (File)
Jun 13 2025, 3:13 PM
Unknown Object (File)
Jun 12 2025, 3:15 PM
Subscribers

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

grahamperrin created this revision.
carlavilla added a subscriber: carlavilla.

Perfect, thanks!

This revision is now accepted and ready to land.Nov 30 2022, 5:11 PM
grahamperrin added inline comments.
documentation/content/en/books/fdp-primer/structure/_index.adoc
155–157

Some wrongness, maybe due to me working with split (not my usual preference) during part of this review.

When a book is viewed as a book, in its entirety:

  • <h2> is used for a chapter (not a section thereof)
  • <h3> is used for the first logical section of a chapter

{F52387089}

AsciiDoc Language Documentation at Asciidoctor Docs – https://docs.asciidoctor.org/asciidoc/latest/ – is definitive, and clear.

Gut feeling: if it's not easy to paraphrase, accurately, what's definitive, then we should remove what's wrong from this book and allow readers to learn from the definitive point of reference.

documentation/content/en/books/fdp-primer/structure/_index.adoc
151

The implication: all books have multiple parts.

Maybe truer to say that a book can have more than one part.

Book Parts | Asciidoctor Docs

  • each chapter is == (AsciiDoc section level 1), not =.

If I understand correctly, FreeBSD Documentation Project Primer for New Contributors is:

  • doctype book and not a not a multi-part book

– it has only one part, with AsciiDoc section level 0 used for its first chapter.

https://cgit.freebsd.org/doc/tree/documentation/content/en/books/fdp-primer/overview/_index.adoc#n13:

= Overview

– and so on.