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.

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

Prose documentation #92

Open
okal opened this issue Dec 19, 2014 · 2 comments
Open

Prose documentation #92

okal opened this issue Dec 19, 2014 · 2 comments

Comments

@okal
Copy link
Contributor

okal commented Dec 19, 2014

Would it be possible to setup a help site, with examples, and detailed description of API functionality? I'd be happy to contribute to that, given the framework for it. I've only been writing Clojure/ClojureScript for about a week now, so I don't know if it's typical in the Clojure community to read the source code when you're getting started with a lib 😄

@jdeisenberg
Copy link

I used Codox and Marginalia to generate documentation. It's here. Not a help site, to be sure, but at least it gives you the comments from the code to help with the API.

@niwinz
Copy link

niwinz commented Jul 13, 2015

Maybe something similar to this:
http://funcool.github.io/cats/latest/
http://funcool.github.io/cats/latest/api/

codox and marginalia generates a very ugly output...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants