Provide full api documentation plus detailed usage examples of the all of kim's features. The docs should also provide a detailed look at the design of kim and what responsibility each part plays.
I think that a scenario would be extremely useful for the usage docs. Something that takes a full working flask application and builds on a simple initial set of examples in a REST api and works up to the more complex areas where the SQASerializers begin to shine.
@krak3n @jackqu7 You guys have any ideas on a scenario the examples can play through?
We could also host the full working application on github so people can check it out and have a play.
[ ] Introduction to KIM ( what is kim, what are its goals and how does it help me)
[ ] Kim Walkthrough
Quickstart flask rest api with basic serializer
Part one - Defining Serializers / marshaling/serializing
Part two - Adding SQA model serialization
Part Three - Handling marshaling/serializing related objects
Part Four - Validation
Part Five - Defining Custom types / Extending KIM
Part Six - ....
Part Seven - ...
[ ] Full detailed apis docs (ensuring that all methods/class/funcs are properly documented)
Provide full api documentation plus detailed usage examples of the all of kim's features. The docs should also provide a detailed look at the design of kim and what responsibility each part plays.
I think that a scenario would be extremely useful for the usage docs. Something that takes a full working flask application and builds on a simple initial set of examples in a REST api and works up to the more complex areas where the SQASerializers begin to shine.
@krak3n @jackqu7 You guys have any ideas on a scenario the examples can play through?
We could also host the full working application on github so people can check it out and have a play.