diff --git a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst index a9a9022..bc3edf2 100644 --- a/docs/DocumentationStyleGuide/language-grammar/capitalization.rst +++ b/docs/DocumentationStyleGuide/language-grammar/capitalization.rst @@ -21,3 +21,25 @@ The guidelines in this case are: - Headline style capitalization should be employed as per the context, like blog posts, research paper titles to use initial uppercase letters for all significant words in the text. +- More detailed explanation on sentence case: + - In sentence case, lowercase most words in a title or heading. Capitalize only the following words: + - The first word of the title or heading + - The first word of a subtitle + - The first word after a colon, em dash, or end punctuation in a heading + - Nouns followed by numerals or letters + - Proper nouns (such as the names of racial or ethnic groups) + ++----------------------------------------------+------------------------------------------------------+ +| Recommended examples | Not recommended examples | ++==============================================+======================================================+ +| Contents: | contents: | +| - Setup Git | - setup git | +| - Install and Configure Git | - Install and Configure Git | ++----------------------------------------------+------------------------------------------------------+ +| Github Workflow | github workflow | +| - example of headline style capitalization. | - proper headline style capitalization is must | +| | - modify depending to context. | ++----------------------------------------------+------------------------------------------------------+ +| Issue raised based on FLINT | issue raised based on FLINT Documentation: | +| documentation : Self-reported issue | seld-reported issue | ++----------------------------------------------+------------------------------------------------------+