Queenie Ma created QUARKS-104:
---------------------------------

             Summary: Documentation website consistency improvements
                 Key: QUARKS-104
                 URL: https://issues.apache.org/jira/browse/QUARKS-104
             Project: Quarks
          Issue Type: Improvement
          Components: Web Site
            Reporter: Queenie Ma
            Priority: Minor


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|http://quarks.incubator.apache.org/docs/common-quarks-operations.html])
# Page headers should start at level 2 using ## in order to have them 
added to the Table of Contents.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to