TG2 doc sprint this weekend

We’ve declared a final feature-freeze on TurboGears in the runnup to the 2.0 release.

But that doesn’t mean that there’s not still lots of work to do. We’re working on a updates to the TG website, radically improved documentation, and better marketing materials. So, we’re having another TG2 sprint this weekend, but this sprint will be focused on infrastructure documentation, and will be the most newbie friendly sprint ever since one of the primary tasks is to make sure that the docs make good sense to new users.

Documentation is hard because the people who write it generally are experts, and have forgotten what’s complicated/confusing to new users. So we really, really need fresh eyes and fresh perspectives.

And one of the most useful things you can do is read and comment on our docs:

If you have a few hours, please join us in #turbogears on IRC on freenode (see this tutorial if you’re new to IRC) and sign up for the sprint here:

3 Responses to “TG2 doc sprint this weekend”

  1. Hi Mark,

    I saw that you have integrated Disqus comments on your documentation. May I ask how well this integration works? Is it very project-specific? If not, I think it would be a nice addition as an extension coming with Sphinx.

    Thanks, Georg

  2. Yea, the integration was actually really simple, but you do have to get a disqus account and inject that into the javascript code that you stick on the page. I’ll write a blog post on how to do this, next week, and if you think it’s valuable I can write up a quick extension.

    I’ve been meaning to blog about how we’re using sphinx including the disqus integration and the simple code retrieval extension we created, but just have not had time with the new job.

  3. That’s great, thanks!

Comments are currently closed.