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

Documentation Improvements #145

Open
indexzero opened this issue May 28, 2013 · 0 comments
Open

Documentation Improvements #145

indexzero opened this issue May 28, 2013 · 0 comments

Comments

@indexzero
Copy link
Member

(Purposeful duplicate of #91)

The documentation needs to be improved for the upcoming 0.3.0 release.

  • Add Table of Contents
  • Add documentation for setting properties / formats / constraints
  • Add relational resource documentation
  • Add documentation for remote methods
  • Add documentation of using restful
  • Add explanation of creating engines
  • Add documentation of using resources in Flatiron app
  • Add documentation for before and after hooks
  • Reduce surface area of docs by moving code examples to /examples/ and link.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@indexzero