Create some sort of Table of Contents

[bwzloranger]

Need a TOC web page based on audit

[bwzloranger]

Referencing ticket #3592 has changed sprint.

[bwzloranger]

had a discussion today with Chris, Scott, and Will regarding the main 'launch page' for documentation, with examples from django, ruby on rails, macnification. the Django launch page at ​http://docs.djangoproject.com/en/1.2/ seemed to be well recieved. Also perhaps ​http://trac.edgewall.org/wiki/TracGuide.

[jmoore]

Django certainly seems usable. Especially for the wiki page, something devs may be use to.

[bwzloranger]

Referencing ticket #3592 has changed sprint.

[bwzloranger]

As an example, I've included a preliminary TOC page on this ticket. If anyone would like to make comments, please do!

[jmoore]

Brian, were there any comments on your html? Any improvements? Where & when is it going live?

[bwzloranger]

Hey Josh, yeah a few comments:

• Some of the links on that page are not active (these are pages that need to be created or are not uploaded yet).
• The clients section has two different kinds of links. The first row of links is 'by action' such as 'Visualizing Data'. These links would lead you to a page where you pick the client, then on to the documentation. The second set of links is 'by client' (the more traditional approach). We can either keep both kinds of links, or choose one over the other.
• The formatting on the page is currently using the trac style, but its CSS based so easily changed if we decide we prefer another look (to make that side bar bigger, for example) or location (like Plone). I suppose this will depend on where it lives.
• As for where it lives, I'm of the opinion we should keep our documentation on the trac wiki. Its where the majority of it lives now, allows for easy formatting and cross-linking, and seems to be where most of the authors (ie: us) like to work. Whether this means it becomes the front page, or a sub-page I'm not sure yet, but I do think the main website should have a very distinctive 'documents' link which is easy to find in one click (This should say 'documents' and not 'support' or something else so people know where to go right away, IMHO).

[jmoore]

Cool. Then why don't you get a live version on the trac with a nice name that everyone can start modifying. Either people'll use it and we can move it to the main landing page, or we can use it as an extra resource (or at least the place where we keep trac of our documentation).