You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@edgent.apache.org by "Queenie Ma (JIRA)" <ji...@apache.org> on 2016/04/16 00:10:25 UTC

[jira] [Closed] (QUARKS-104) Documentation website consistency improvements

     [ https://issues.apache.org/jira/browse/QUARKS-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Queenie Ma closed QUARKS-104.
-----------------------------
    Resolution: Fixed

> 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
>            Assignee: 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 &#35;&#35; in order to have them added to the Table of Contents.



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