Details
-
Improvement
-
Status: Closed
-
Minor
-
Resolution: Fixed
-
None
-
None
-
None
Description
Some parts of the documentation site are inconsistent with each other, such as capitalization and differences between the sidebar titles and page titles.
Possible improvements:
- Remove the numbering of subsections (i.e., "Get Started", "Sample Programs", "Using The Console")
- Commit to using title case capitalization (i.e., all words capitalized, except for minor words such as 'the', 'of', 'to', etc.) for sidebar/page titles and sentence case capitalization (i.e., first word capitalized) for page headers
- Redundant headers should be removed (e.g., see Common Quarks Operations)
- Page headers should start at level 2 using ## in order to have them added to the Table of Contents.