[GMG-Devel] Help extract documentation from my brain

Christopher Allan Webber cwebber at dustycloud.org
Sat Jul 16 16:45:21 EDT 2011


Hi all,

We'd like to improve our documentation.  Fortunately, a lot of people on
our team are coming up to speed with the codebase and have a pretty good
idea of how things work.  Unfortunately a lot of it is in my head, but I
don't have time to work on nice docs because I need to focus on the
codebase.

Here's a solution.  A lot of the initial documentation was extracted
from some "braindump" files I wrote and was rewritten by other people
(largely Will, but also some other volunteers) into something more
coherent.  I think we should do the same thing again.

So over the next few weeks I'm going to braindump about various topics
on-list.  Is there anything mysterious about the codebase or etc that
you want clarified?  Here's a list of topics I think I should braindump
about, feel free to make more requests:
 - Database stuff
   - Migrations
   - Indexing
   - What are all the fields?  (Should add docstrings)
 - How to add new views (including routing)
 - Config stuff
 - Templates
 - General style concerns
 - Testing
 - Storage, and the storage API
 - What is the workbench?
 - ???

Feel free to expand on this, and I'll start braindumping!

-- 
http://dustycloud.org/


More information about the devel mailing list