[Twisted-Python] Proposed new homepage

Stephen Waterbury waterbug at pangalactic.us
Sun Oct 9 13:25:19 MDT 2011


On 10/09/2011 02:44 PM, Itamar Turner-Trauring wrote:
> Our current page is not good at pulling in potential new users:
>
>        * There's no quick examples of how nice Twisted is.
>        * It takes 3 clicks (3!) to find basic documentation, with lots of
>          scope for getting lost along the way.
>
> I propose to fix this by adding code examples, and relevant direct
> documentation links. A very preliminary pass, still lacking things like
> syntax highlighting, can be found here:
>
> http://twistedmatrix.com/trac/wiki/ProposedWikiStart
>
> What do you think?

Opinions from a long-time observer, who is not offering to
contribute -- sorry!  totally swamped ... :(

* I agree that quick examples should be more accessible.  I think
   the ones that go (possibly) somewhere on the homepage need to be
   carefully chosen (whatever that means ;).  I confess that my
   preference would be to have the "What is Twisted?" section
   extremely short (like maybe a 2-sentence paragraph with its
   current links) and then the "Quick Links" section right after
   that but have the "More Useful Pointers" section perhaps as an
   expandable part of the Quick Links, so that the next section
   could be Quick Examples and at least the beginning of the
   examples would be visible without scrolling (I like to
   avoid having to scroll to see the major structures on a page).

* I don't get your point about 3 clicks to find basic documentation --
   doesn't the link to "Twisted Core Documentation" in the 3rd
   paragraph get you there in one click?  Of course, the "basic
   documentation" will be nicer when the Sphinx-based docs arrive,
   I think ...

Steve




More information about the Twisted-Python mailing list