I've actually been thinking about this exact same kind of site for a while now and I'm thrilled that I was too lazy to do it so that you could do it instead. :)
One idea that I have that I think would be killer would be to provide an API to look up one your examples at the repl so I could do something like: => (use 'clojuredocs) => (example map) clojure.core/map (since 1.0) (map inc [1 2 3 4 5]) (2 3 4 5 6) There are of course many variants of some functions and different forms of use, so dealing with the best way to provide useful help without an overwhelming number of examples is tricky in the repl, but I think worth doing. Along with doc and source, I think example would be a killer addition to allowing you to explore the libraries from the comfort of your repl. Alex On Jul 9, 3:32 am, zkim <zachary....@gmail.com> wrote: > Hi All, > > I'll try to keep this short. > > I've gotten a lot out of Clojure: I can honestly say that learning > this language, and being part of this community has made me a better, > happier developer, and I wanted to give something back. > > One of the pain points that I encountered when learning the language > was a lack of examples specific to the individual functions I was > trying to wrap my head around at any given time. So I took a whack at > the problem, and came up withhttp://clojuredocs.org. It's a site > that (I'm hoping) will fill this need by providing a centralized > examples database, along with solid search capabilities across both > core and third party libraries (core being the focus). > > Implementation: > ClojureDocs.org is a rails site backed by MySQL, along with some > clojure code to pull the namespaces / metadata / source and dump them > into the database. > > Highlights: > 1. Documentation and source for Clojure core, contrib, and a few third > party libraries (random selection out of what I'm personally familiar > with, and whatever was on the github trends page that day). > > 2. Search for a var across the whole ecosystem or in a specific > library. > > 3. Per var wiki-style examples section. > > 4. Per var comments section. > > 5. Per var vars-in-this-var and this-var-used-in section (my personal > favorite). Looking for a real-world example of a specific function? > This is for you. For example,http://clojuredocs.org/v/1978, just > below the source section. > > Lowlights: > 1. Ugly URLs! There's a problem in the way that URLs with encoded > question marks are being handled, so I had to move > fromhttp://clojuredocs.org/clj-ssh/clj-ssh.core/file-pathtohttp://clojuredocs.org/v/1484. > I've got an email out to the Phusion > Passenger mailing list (http://groups.google.com/group/phusion- > passenger/browse_thread/thread/ed2eadfdac5c166f) but if you've got any > experience in this area drop me a line. > > 2. Strange var names (http://clojuredocs.org/v/781). Probably a bug > in the import process. > > 3. General rough-around-the-edges-ness. > > I'm treating this as an alpha, and I'd really like feedback as to: > a. How useful this would be to the community. > b. Specific likes / dislikes about this alpha release. > c. Feature requests. > > I've set up a feedback mechanism directly through the site (User > Voice), which allows voting on specific posts. I'm also considering > setting up a google group for general discussion. Feel free to > contact me directly through email. > > Questions / thoughts? > > -Zack -- 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
