While there's no frontend such as suchwow or thalia for installing docstrings into a running Clojure instance, lib-grimoire [1] was literally designed with this sharing of examples and docs in mind. There is a repo [2] of all the examples and (markdown) notes in the Grimoire service, the goal of which is explicitly that it can serve as a shared pool of better docs licensed CC0. I'm grateful to Justin (noisesmith) Zach (zkim) and Andy (andyf) for releasing their examples and notes as such and I'd be delighted to work with any/all of you on merging other example and doc sources in. My plan is that when Richard, the GSoC student, is finished lib-grimoire and the datastore will be reworked atop his data representation.
I'm also advising the GSoC documentation representation project, which is publicly visible [3] [4] although not yet advertised. I'll ping Richard to keep an eye on this thread. Reid [1] https://github.com/clojure-grimoire/lib-grimoire [2] https://github.com/clojure-grimoire/datastore [3] https://github.com/clj-grenada/grenada-spec [4] https://github.com/clj-grenada/lib-grenada On Mon, Jul 13, 2015 at 10:38 PM, Mikera <mike.r.anderson...@gmail.com> wrote: > Can we get links? Initial design docs? > > This is the first I heard of this, but sounds like something that could do > with a decent amount of community discussion and feedback if we are going > to establish a good standard. > > Some properties of such library metadata I'd like to see: > 1) Works equally well for 3rd party tools as for clojure.core > 2) Docs can be either separate or packaged in the library .jar > 3) Tool independent (i.e. works equally well with lein, maven, cursive, > counterclockwise) > 4) Plans to migrate other tools / documentation formats > 5) Well suited to automatic generation of documentation sites > 6) Well suited to git workflows / merging contributions etc. > > > On Tuesday, 14 July 2015 09:29:23 UTC+8, Alex Miller wrote: >> >> This is the ballpark of one of the Google summer of code projects - >> defining library metadata via a data format and tools to allow it to be >> combined, etc. > > -- > 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. > -- 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.
