[Bug 296223] Capitalization is inconsistent across pages
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 23 Jun 2026 03:36:53 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=296223
Bug ID: 296223
Summary: Capitalization is inconsistent across pages
Product: Documentation
Version: Latest
Hardware: Any
OS: Any
Status: New
Severity: Affects Only Me
Priority: ---
Component: Website
Assignee: doc@FreeBSD.org
Reporter: quentin.thebault@defenso.fr
I could not find a defined standard looking at the doc repo. Is it defined
anywhere else? In any *case* the content is inconsistent.
Some headings are "heading-style" as per The Chicago Manual of Style:
> Policies of the Ports Management Team
https://github.com/freebsd/freebsd-doc/blob/eeb699f42790688092cb169d5a10b77d9a36da4b/website/content/en/portmgr/policies.adoc
Some headings are all capitalized:
> Assure The Integrity Of The Ports Collection
also
https://github.com/freebsd/freebsd-doc/blob/eeb699f42790688092cb169d5a10b77d9a36da4b/website/content/en/portmgr/policies.adoc
Some headings are all lowercase except starting letter:
> Changes when the tree is open
(*tree* would likely be capitalized as an important word under CMOS rules)
https://github.com/freebsd/freebsd-doc/blob/eeb699f42790688092cb169d5a10b77d9a36da4b/website/content/en/portmgr/policies_committing.adoc
Note that the title on that page is a mix of both:
> Policies of the Ports Management Team: Committing To The Tree
I think capitalizing everything makes reading more difficult.
What about choosing a standard, hopefully with a little less caps, and then
work our way to consistency, maybe adding an automatic lint in the process?
--
You are receiving this mail because:
You are the assignee for the bug.