Dave Lester created AURORA-866:
----------------------------------

             Summary: Autogenerate TOC for documentation pages
                 Key: AURORA-866
                 URL: https://issues.apache.org/jira/browse/AURORA-866
             Project: Aurora
          Issue Type: Task
          Components: Documentation
            Reporter: Dave Lester


Several pages in the Aurora documentation are quite lengthy, and in order to 
navigate them easily have table of contents with anchor links to various parts 
of the doc. These TOC are manually generated using tools like DocTool [1].

That's great, but it falls short of what it could be:
1) updated whenever a new h1 h2 or h3 is created in the document, and
2) styled with CSS to give the page some more structure and provide secondary 
navigation.

I propose that we update the website to auto-generate table of contents for 
documentation when rendered on the page, and also remove any manually-entered 
TOC that current exist.

__
[1] http://doctoc.herokuapp.com



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

Reply via email to