Re: [ANN, GSoC] A Common Clojure Source Metadata Model
Am Mittwoch, 6. Mai 2015 07:17:54 UTC+9 schrieb kovasb: I'm mostly interested in something like http://docs.racket-lang.org/scribble/ Thanks for the idea! There is http://clojure-scribble.publicfields.net/, which you might know already. Maybe something like that could also be integrated with the output of my project. But let me clarify again, because maybe this hasn't come across clearly enough: my project is not about creating another tool for generating documentation pages. Rather, I want to think about what aspects of Clojure code describe how to use a namespace. That's vars, records etc. along with their doc strings, argument lists etc. and positional information. I have to think how these can be captured and then output as data in various ways. That could be storing in Datomic, deploying to Clojars and so on. Other tools can then use these data for their purposes like building documentation pages or recording the evolution of the API like Codeq. @Alex Miller: If I'm mangling your ideas, please correct me! 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.
[ANN, GSoC] A Common Clojure Source Metadata Model
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.
Re: [ANN, GSoC] A Common Clojure Source Metadata Model
I just saw that the plain text formatting is horrible. Sorry for that. -- 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.
Re: [ANN, GSoC] A Common Clojure Source Metadata Model
Am Dienstag, 5. Mai 2015 01:56:13 UTC+9 schrieb Sean Grove: 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. Oh, Codeq! I heard about it a long time ago on the Cognicast and it has been hopping across my mind now and then. I would also like it to come to life again. While it's not quite in the scope of my project, I think it could be one of the tools that can be (re)built on top of the metadata from my project. Maybe I'm remembering Codeq wrong, but I think it could just be recording the changes/snapshots of metadata according to my model over time by feeding them into Datomic. -- 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.
Re: [GSoC] Source meta information model proposal
Am Mittwoch, 18. März 2015 07:18:30 UTC+1 schrieb Reid McKenzie: Alex, glad to see we're on the same wavelength about this more or less. Christopher, some other deliverables worth considering: Hi all, so I'm the other student Alex mentioned. I'm not participating so much in this discussion, since there will be enough time during the community bonding phase of the GSoC. My proposal is already on Melange, the place where all proposals go in the end. I've made it public now (http://www.google-melange.com/gsoc/proposal/public/google/gsoc2015/rmoehn/5629499534213120). It will go through some more revisions, though. But it mainly contains general stuff about the project and process and how I intend to go about things. Getting input from the community and knowledgeable people (i.e. you) will be part of those. 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.
