[
https://issues.apache.org/jira/browse/QUARKS-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15230492#comment-15230492
]
Queenie Ma commented on QUARKS-104:
-----------------------------------
Hi Julia, thanks for the feedback.
# Yes. For example, in the "Get Started" section, "Getting Started Guide" and
"Common Operations" are numbered 1 and 2, respectively. The ordering is not
dependent on the numbering, but rather the positioning in the file relative to
other sections.
# I see... I suggested headline style since the majority of the titles already
implement this. I do prefer sentence style as it looks cleaner. I will push for
sentence style: capitalize the first word and all proper nouns.
# Thank you!
# When you prefix a header with ##, it automatically gets generated in the
Table of Contents by Jekyll. Similarly, a header with ### becomes a subheader
of the header one level above it. I hope that adequately answers your question.
> 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)
