search

jamesmacaulay / zelkova

Elm-style FRP for Clojure and ClojureScript
MIT License
403 stars 9 forks source link

API Documentation #7

Closed dubiousdavid closed 9 years ago

dubiousdavid commented 9 years ago

Please add API documentation. I'd be happy to help. Just let me know.

David

sparkofreason commented 9 years ago

+1

bensu commented 9 years ago

@jamesmacaulay would you be ok with codox or marginalia?

jamesmacaulay commented 9 years ago

Yeah, I think codox generated in the gh-pages branch and then linked from the README makes sense.

bensu commented 9 years ago

This in now work in progress. Both codox and codeina needed work in order to support a cljc codebase. I chose codeina instead of codox because it does not attempt to be backwards compatible with earlier Clojure version, making the refactoring much easier.

@jamesmacaulay if you are interested in publishing the docs before the PR is merged and deployed let me know.

jamesmacaulay commented 9 years ago

Thanks @bensu! Sounds great. We can wait a few days/a week, then go ahead with doc generation from your fork if that PR hasn't been merged by then.