[AURORA-981] Dynamically generate table of contents for documentation

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Won't Fix
• Component/s: Documentation
• Labels: Website
• Assignee: Dave Lester
• Reporter: Dave Lester
• Created: 23/Dec/14 20:08
• Updated: 28/Dec/15 02:26
• Resolved: 28/Dec/15 02:26

Description

The Aurora documentation tends to be lengthy, and as a result many pages require a table of contents to easily navigate their contents. This is currently maintained manually, and has a few shortcomings:

1) It becomes out of date quickly as documents are revised
2) It cannot be easily styled without adding additional markup
3) There are large inconsistencies in the ToC that documents currently have

Instead, I'd like to see us remove the static ToC that currently exists in the docs, and instead generate them when they are rendered by the website's Middleman CMS.

Issue Links

• is blocked by: AURORA-982 Use documentation template when rendering docs on Aurora website
• is blocked by: AURORA-983 Standardize documentation markdown, publish style guide