Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation outline #22

Open
bobdobbs666 opened this issue Oct 23, 2011 · 1 comment
Open

Documentation outline #22

bobdobbs666 opened this issue Oct 23, 2011 · 1 comment
Labels
Milestone

Comments

@bobdobbs666
Copy link
Contributor

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.
@runyaga
Copy link
Member

runyaga commented Nov 10, 2011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants