ptahproject/ptah — Issue #22: Documentation outline
Author: bobdobbs666
Created: 2011-10-23 05:28:41+00:00
State: open

People are editing documentation. I believe it is time to come up with outline for complete documentation. Some notes::

- Rewrite installation instructions (they work but are incomplete)

- Complete tutorial (need this for usability testing next week)

- Defense of why ptah.form and not colander/deform (defense of Why not Mongo or ZODB is not nearly as important)

- Enumerate all Ptah terminology and naming; ApplicationRoot, RootFactory, etc. Field, FieldSet, Snippet, Layout, Formatter, and others. Especially WSGI App vs. Ptah.ApplicationXXXXXX - this could be confusing to experienced developers.

- Define limitations of Ptah and Pyramid. Since Ptah uses a custom traverser you can only use Ptah's traverser and register routes. This means you get Ptah's traverser and your extension should be by routes. Which reduces people's choices unless they want to subclass Ptah Traverser and do everything themselves.