Documentation Improvements #91

Closed
Marak opened this Issue Jul 17, 2012 · 5 comments

Projects

None yet

4 participants

@Marak
Contributor
Marak commented Jul 17, 2012

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.
@pksunkara
Contributor

Some documentation in 7c4e8b2

@Marak
Contributor
Marak commented Aug 30, 2012

I updated and added several wiki pages

see: https://github.com/flatiron/resourceful/wiki

@jeffgorder

Add further validation documentation...perhaps just a link to https://github.com/flatiron/revalidator in the readme. Helps if you don't want to look around for validation options.

@Marak
Contributor
Marak commented May 27, 2013

Invalid

@Marak Marak closed this May 27, 2013
@indexzero
Member

Duplicate of #145

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment