• Overview: Current api and developer documentation on plone.org is often out of date or incorrect and not easy to use.
  
• Goals:
  
• have developer documentation release at the same time or before plone releases
• ensure all code examples work
• provide an easy to navigate and search replacement for greping the code
• easy the learning curve with careful selection of tutorials and getting started guides
• provide guidance on when more than one way exists to solve a problem 
• comment documentation (possible solution is using wsgi middleware)
  
• Planning:
  
• Explore extending api.plone.org  with sphinx based documentation
• Look at replacing parts of plone.org docs with sphinx
  
• Trial the idea of using a open editing for developer documentation via http://www.kaizenplone.org  or another form of wiki 
• Kaizenplone needs the following to be implemented
• pbwiki style changebot. Combined daily email of diffs on all relevant pages. Should be just the pages the user is watching.
• Some UI changes or content type to guide users on creating and editing FAQ pages.
  
• Combined voting and watching. users put their name next to solutions they use/endorse which also adds them to the watchers list. Views can decide on which solution they trust based on who endorses it.
  
• Links: Are there other websites with related information?
• http://pypi.python.org/pypi/z3c.recipe.sphinxdoc  (package that helps provide documentation for z3c packages using sphinx)
• http://tarekziade.wordpress.com/2008/09/11/zcbuildout-recipe-to-build-your-sphinx-doc  (tarek was already doing something with sphinx, collective.recipe.sphinxbuilder)
• repoze team also cameup with something that they use http://repoze.org/viewcvs/repoze.sphinx.autointerface/
  

Edit this page:

Edit this page using the edit button above.

Create a new page:

Add a new page by enclosing the title of the page in ( (double parentheses) ). Once you hit “Save” the text will change into a link to create the new page. If a page with that name already exists, the text will link to that page.