cartjs
cartjs copied to clipboard
discolabs
WIP: DOM Binding Docs
This is still very much a WIP, and so is not yet in a condition to be merged, but I have opened this PR to provide a place for continued discussion.
Key pieces still missing:
- [x] Breaking out the different sections in the Guide into their own subfolder so that they appear correctly in the nav
- [x] Completing the list of formatters on the Reference page (have completed three to give an indication of direction)
- [ ] Better documentation of error and success callback handling
- [ ] Add "for theme designers" section, giving some guidance and best practices for making Cart.js powered themes compatible and easily extensible (see #66).
- [ ] Add references to cover usage described in #82
@gavinballard, I have left the unsquashed branch up for now, but had planned to clean up the commits before offering up for merging, though equally happy to leave full commit history in place if you would prefer.
This all looks really good @michaelrshannon! I made a few comments on various commits, keen to hear your thoughts. I'm happy to help out with this, so feel free to leave any grunt work (for example, documenting some formatters) to me.
Feel free to rebase and squash commits as you like, I'm not too picky about such things :).
Thanks for all the feedback - always great to get a second pair of eyes! Will iterate on this over the next week, and give you a shout if an extra pair of hands would be useful!
@michaelrshannon Just letting you know that I've updated your comment at the top of this PR to capture some of the other requirements for documentation.
I know it's been a while, but it would be great to have these doc updates merged in, they're very helpful compared to what's currently being displayed for the Dom Binding section.
@michaelrshannon Any sense of whether this PR is good to go in? /cc @curiouscrusher