Uploaded image for project: 'Edgent'
  1. Edgent
  2. EDGENT-104

Documentation website consistency improvements

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • None
    • None
    • Web Site
    • 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:

      1. Remove the numbering of subsections (i.e., "Get Started", "Sample Programs", "Using The Console")
      2. 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
      3. Redundant headers should be removed (e.g., see Common Quarks Operations)
      4. Page headers should start at level 2 using ## in order to have them added to the Table of Contents.

      Attachments

        Activity

          People

            queeniema Queenie Ma
            queeniema Queenie Ma
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: