search

clojure-grimoire / grimoire

Community documentation of Clojure
http://conj.io
159 stars 41 forks source link

And the community? #28

Closed BertrandDechoux closed 10 years ago

BertrandDechoux commented 10 years ago

It should be for further in the roadmap but....

arrdem commented 10 years ago

Clojure already has several shall we say "autodoc" tools.

It has been suggested that Grimoire would benifit from featuring documentation of the other Clojure Contrib libraries (tools.reader, core.logic, algo.monads and soforth). As described here on my blog I see Grimoire's potential value not to be generated documentation, but curated examples and augmented documentation. Grimoire's cheatsheet and examples are human built and human maintained products in this direction of having high quality content and indexing which no iteration of Grimoire as a docs site generator would be able to provide to users.

Along those same lines I'm not sure that Grimoire should really be open to the contribution of libraries. CrossCLJ already does an amazing job of that. As previously mentioned I think that Grimoire's future lies in being an active and curated repository of spells for Clojure core. But this may change.

BertrandDechoux commented 10 years ago

I didn't know about codox and autodoc, thanks. These two points about the community were not asked on github so I had too. I hadn't read your blog at that time. Your position is clear and sound (and public).