doc: standardize on sentence case for headers

Previously, our documentation headers were a mixture of title case, sentence case, and things that were neither. For technical documentation, the _de facto_ standard seems to be sentence case. (See refs below.) So let's standardize on that. This commit follows a commit implementing this standard. This commit adds it to the style guide. Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization PR-URL: nodejs#33889 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
ricka · Jun 19, 2020 · 563062e · 563062e
1 parent d1d412b
commit 563062e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md
@@ -68,6 +68,9 @@
   <!-- lint enable prohibited-strings remark-lint-->
   * OK: _Node.js 14.x_, _Node.js 14.3.1_
   * NOT OK: _Node.js v14_
+* For headings, use sentence case, not title case.
+  * OK: _## Everybody to the limit_
+  * NOT OK: _## Everybody To The Limit_
 
 See also API documentation structure overview in [doctools README][].