[Python-Dev] [Preview] Comments and change proposals on documentation

Wed Nov 24 21:24:49 CET 2010

Hi,
at <http://dpo.gbrandl.de/contents>, you can look at a version of the 3.2
docs that has the upcoming commenting feature. JavaScript is mandatory.
I've switched on anonymous comments for testing, but usually at least
comments from anonymous users can be moderated. Be sure to test the
"propose a change" feature too. Login currently allows OpenID exclusively.
Credits go to Jacob Mason, whose GSOC project is responsible for almost all
of what you see there. [1]
Please test on a smaller page, such as <http://dpo.gbrandl.de/library/math>,
there is currently a speed issue with larger pages. (Helpful tips from
JS experts are welcome.)
Other things I have to do before this can go live:
* reuse existing logins from either wiki or tracker?
* (re)Captcha integration for anonymous comments
* easier moderation (currently emails are sent on new comments)
* facility for (semi)automatic applying of proposals (once Hg is live, this
 should be easy to do due to the separation between commit and merge)
* allow commenting on code blocks (figure out where to place the "bubble")
Any feedback is appreciated (I'd suggest mailing it to doc-SIG only, to avoid
cluttering up python-dev).
Have fun,
Georg
[1] The source for the webapp is at
 <http://bitbucket.org/jacobmason/sphinx-demo-webapp>, but most of the
 functionality is implemented in Sphinx trunk.