.. title: Better developer documentation for Miro
.. slug: developer_docs
.. date: 2009-07-09 16:20:22
.. tags: work, miro, python

<p>
  During the Miro 2.5 development cycle, I've been working on getting
  better developer documentation cobbled together.  It's a huge task
  that'll take us a while to do.
</p>
<p>
  The initial focus of this developer documentation is two-fold:
</p>
<ol>
<li>provide web-based documentation for architecture, modules, classes, 
    methods, functions, ...
<li>codify project standard practices
</ol>
<p>
  This is important because it makes development easier for core
  developers, but it's even more important because it'll make it easier
  for casual contributors to figure out where everything is and how it
  works.
</p>
<p>
  This is in addition to the documentation found at the
  <a href="https://develop.participatoryculture.org/trac/democracy/wiki">Miro Development Center</a>
  (aka our Trac wiki).  Some content will move from the Miro Development
  Center to the developer docs, but we'll have both for a long time to
  come.
</p>
<p>
  The first pass for developer documentation for Miro 2.5 is at 
  <a href="http://pculture.org/wguaraldi/miro/2.5/developer/">http://pculture.org/wguaraldi/miro/2.5/developer/</a>.
  It answers such questions as:
</p>
<ul>
<li>how do I add support for a new search engine?  (<a href="http://pculture.org/wguaraldi/miro/2.5/developer/searchengine_modules.html#how-to-add-a-search-engine">see here</a>)
<li>how do I help translate Miro?  (<a href="http://pculture.org/wguaraldi/miro/2.5/developer/translating.html#adding-a-new-translation">see here</a>)
<li>where's all the database code?  (<a href="http://pculture.org/wguaraldi/miro/2.5/developer/database_modules.html">see here</a>)
</ul>
<p>
  There's a lot more to do, but it'll get better over time if people spend
  time on it.
</p>
<p>
  For those interested, I'm making heavy use of 
  <a href="http://sphinx.pocoo.org/">Sphinx</a>.  You can see the source
  from the developer documentation by clicking on the "Show source" link
  on the left hand side.  The source for the documentation is in our svn 
  tree at 
  <a href="https://develop.participatoryculture.org/trac/democracy/browser/trunk/docs/developer">https://develop.participatoryculture.org/trac/democracy/browser/trunk/docs/developer</a>.
</p>