I've been hoping someone would rebuild Codeq <https://github.com/Datomic/codeq>, now that tools.analyzer (and friends) is out and ClojureScript has made so much progress. Not only would it be useful for diving into a new codebase (I've needed it several times when working with a large, unfamiliar codebase), but generating both useful and interesting docs from the structured data should be far easier than ad-hoc analysis.
Just a thought, not sure that's the angle you want to take, but didn't see it on your list and each of the items on the list would probably have benefited from a revamped, well-documented, well-marketed Codeq. On Mon, May 4, 2015 at 12:30 AM, <richard.mo...@posteo.de> wrote: > Hi all! > > I'm one of this year's students accepted to the Google Summer of Code for > doing > a Clojure project. (Thanks to Alex Miller for supporting my application!) > For > those who like to decide from the first paragraph whether they will read > on or > not: the goal of my project is to develop a model for Clojure source > metadata > (most of them are documentation) and ways to capture and publish them. The > following two paragraphs are taken from my project proposal: > > ❧ To the joy of the community, the number of Clojure-based libraries is > steadily growing. To the dismay of the community, there is no agreed-upon > way of > getting information about those libraries' APIs. We have API documentation > generators for individual libraries, like Autodoc or Codox. And we have big > overview sites like Grimoire and CrossClj. None of them are comprehensive. > All > provide their information in a human-friendly way. Only some cater for the > computer. > > The goal of this project is to develop a comprehensive and extensible > model for > describing Clojure sources from an API perspective. I will also write a > program > that analyses Clojure sources according to this model and outputs data > documenting their usage. This could be compared to Javadoc, but emitting > data to > be consumed by other tools instead of HTML. In order to foster adoption, I > will > provide extensive documentation, including examples of such consumer > tools, and > emphasize active communication with the community. ☙ > > The project idea comes from Alex Miller, who also is my mentor, together > with > Reid McKenzie. Coding for the GSoC hasn't started yet. – Until 24 April > we're in > the warmup phase called community bonding. I wanted to use this time for > getting > ideas and feedback from you, so I've prepared some questions as a starting > point: > > - Who is interested in the project? > - What would you like to see? > - Who has done/thought about similar things? > - What have you done? > - How have you done it? > - What have you found? – Difficulties, annoyances, surprises. > - What would you like to see? > - What is important to you? > - Have you built something that I might reuse? > - What else comes to your mind? > > There are many things out there which are more or less closely related to > my > project: > > - cljs.info: https://github.com/cljsinfo > - Autodoc: https://github.com/tomfaulhaber/autodoc > - Codox: https://github.com/weavejester/codox > - Grimoire: http://conj.io/ > - CrossClj: https://crossclj.info/ > - ClojureDocs: https://clojuredocs.org/ > - Clojure Atlas: http://www.clojureatlas.com/ > > I would be especially happy to receive input from the people involved in > those > efforts. > > Reading this might help not having to say things again that have been said > before: https://groups.google.com/d/topic/clojure/E1oxVE4UMxQ/discussion > > I wish everyone a good summer! > > 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. > -- 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.
