Hey Richard, Great work on the project! I'd love to see the final generated output if you have time to do so. Also, we at Helpshift are working on a similar project here - https://github.com/helpshift/hydrox. It'll be great to get your input to see how the two libraries compare, what each one potentially solves and whether there is synergy for solving the documentation problem.
Chris. On Wednesday, August 19, 2015 at 1:37:56 PM UTC+5:30, Richard Möhn wrote: > > This project was announced three months ago as a ‘Common Clojure Source > Metadata Model’. You might also have read about it > <http://us4.campaign-archive1.com/?u=a33b5228d1b5bf2e0c68a83f4&id=52f3bba560> > in the Clojure Gazette. It is now called Grenada > <https://github.com/clj-grenada/grenada-spec> and can be described > vaguely as a Clojure metadata build and distribution system. Features: > > - for library authors: assemble and publish (API) documentation > packages similar to Javadoc JARs, but containing well-defined data instead > of HTML. > - for developers: provide structured information in addition to doc > strings. Annotate Clojure objects that don't support doc strings with > easily accessible documentation (to be implemented). > - for documentation editors: jazz up the documentation of existing > Clojure libraries; assemble documentation and examples from different > sources. > - for toolsmiths: build on a rigorously flexible model of metadata > about things in the Clojure ecosystem > > (Taken from the project home page > <https://github.com/clj-grenada/grenada-spec>.) > > Notable products of the project: > > - a data model > <https://github.com/clj-grenada/grenada-spec/blob/devel/SpecOverview.md> > (can be understood as a draft) > - lib-grenada <https://github.com/clj-grenada/lib-grenada>, > implementing the model and providing convenience > - the concept of Datadoc JARs – like Javadoc JARs, but instead of HTML > containing EDN files with documentation and arbitrary other data > - a Leiningen plugin <https://github.com/clj-grenada/lein-datadoc> > producing and deploying such JARs for your project > > Status: > > - Everything is usable, though not very convenient at times. If you've > read the example of Dorothy the Documenter in the Clojure Gazette > interview: what is described there works > <https://github.com/clj-grenada/lib-grenada/blob/devel/doc/tutorial.md> > . > - The documentation is fairly extensive, though not well-organized. > - The auxiliary library Jolly <https://github.com/clj-grenada/jolly> > can be used to convert Grimoire <http://conj.io> data to Datadoc JARs > <https://clojars.org/org.clojars.rmoehn/clojure>. > - I would be happy if you use the Leiningen plugin to deploy Datadoc > JARs for your libraries to Clojars. – Some day there might be an > application which displays those data in a way similar to Autodoc or > Codox. > – The plugin has some issues, though, so don't get wound up. > > There's still plenty to do > <https://github.com/clj-grenada/grenada-spec/blob/devel/roadmap.md>, but > I'd be happy if you take a look. Code and history can be found under the > Grenada > organization <https://github.com/clj-grenada> on GitHub. > > > Richard > -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
