Documentation index

[mesozoic]

Says Glyph:

1. Go to  http://twistedmatrix.com/documents/current
2. Be embarrassed on our behalf.

Let me see if I can improve that a little bit.

This is different than the task to integrate documentation across all of the Twisted modules, so that there is a way to navigate from  Twisted Core Documentation back to the documentation index.

[mesozoic]

(In [33317]) Branching to 'doc-index-5429'

[jesstess]

Thanks for working on this, mesozoic! This is vastly improved from the current state of the world. A few comments:

• I'd remove "Documentation" from all of the top-level links, e.g. "Twisted Conch Documentation" ==> "Twisted Conch", since it has both documentation and examples and "Documentation" is already used in a nested link.
• There are some inconsistencies in the naming:
  • "Twisted.Subproject" and "Twisted Subproject" are variously used
  • "Twisted Words" is sometimes called "Twisted IM"
• I might just call "Twisted Mail Tutorial: Building an SMTP Client from Scratch" "Twisted Mail Documentation" for parallelism
• Upgrading is obsolete and shouldn't be linked anywhere (it should get removed, but that can happen in another ticket)

[mesozoic]

Good suggestions, all of them. Duly committed. Ready for review again.

[jesstess]

This looks great, please merge!

[mesozoic]

(In [33398]) Merge doc-index-5429

Author: mesozoic Reviewer: jesstess Fixes: #5429

Add an index page to the documentation tree and make references to "Twisted Products" within the documentation more consistent.

[exarkun]

This was a duplicate of #5419. I marked that one as the duplicate, though, since this one is closed already.