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.

Sign up for GitHub

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

Jump to bottom

Improve docs #156

Closed
1 of 22 tasks
vangheem opened this issue Oct 19, 2017 · 0 comments
Closed
1 of 22 tasks

Improve docs #156

vangheem opened this issue Oct 19, 2017 · 0 comments
Assignees
@vangheem

Comments

@vangheem
Copy link
Member

vangheem commented Oct 19, 2017 •
edited
Loading

  • use type hinting for programming API, auto docs
  • fix documenting programming api(read the docs)
  • docs for interfaces, auto doc
  • touch up addon docs
  • document tus API
  • document all endpoints(like swagger but not needing swagger)
  • auth framework, how to extend, configure and use
  • document how to write your own configurator
  • document component features(getUtility, getAdapter)
  • document extending cloud storage
  • document useful applications
  • document serialization and validation(un-included field validation) framework
  • document available schema fields
  • document security functions
  • document request object
  • document annotations
  • document registry
  • document renderers
  • document testing
  • document transaction helper functions
  • utils
  • directives
@vangheem vangheem self-assigned this Oct 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vangheem vangheem

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vangheem