Greg- I'd like to take the time to look over the post you linked in-depth before responding.
> but what do you think about using Justin's codebase, or an Aleph-based server > to > host the thing instead of Ruby/Rails? (see the link above for more details) I'm inclined to move forward with the Ruby / Rails for now. The reason I went with rails is that (in my experience) none of the clojure web libraries are mature enough to do something like clojuredocs as quickly and easily as I personally would be able to do in rails. I'd like to be explicit here: I think the work that cgrand, mmcgrana, weavejester, brentonashworth, et al is amazing. I will be the first to get a big fat lambda tattoo on my forehead once the day comes that I can do all my web dev stuff in Clojure (please nobody hold me to this), but I'd like to wait till the web space matures a bit more before porting it over. The bottom line here is that I'd like to deliver the best possible user experience that I can, and as of right now that means a rails based solution. -Zack On Jul 9, 5:23 pm, Greg <g...@kinostudios.com> wrote: > *argh*. well at least my email is now finally on the whitelist. > > What do you guys think of some of the ideas presented in the "Solving > Clojure's Documentation Problem Without Fragmentation" thread? (Which I sent > shortly after this thread started, but ended up being posted several hours > later). > > https://groups.google.com/group/clojure/t/77fda1c7c95f5344 > > - Greg > > P.S. clojuredoc.org might be irrelevant if you guys choose to collaborate on > the same project, but what do you think about using Justin's codebase, or an > Aleph-based server to host the thing instead of Ruby/Rails? (see the link > above for more details) > > On Jul 9, 2010, at 7:05 PM, Justin Kramer wrote: > > > > > An "examples" function for the REPL that pulls from the wiki: > > >http://gist.github.com/470031 > > > I'm sure something like it could be made for ClojureDocs.org once the > > API is in place. > > > General comments on ClojureDocs.org: I think an important aspect of a > > collaborative tool like this is quality control. There needs to be > > people watching recent updates, making sure examples meet certain > > standards (formatted correctly, idiomatic, etc.). To that end, a > > complete list of recent updates (with diffs) to go along with the > > short list on the homepage would be really nice. > > > Having a category-based outlines would also be nice. I have one here > > for clojure.core, adapted from the Cheatsheet: > > >http://clojure-examples.appspot.com/clojure.core > > > Feel free to nab it. > > > FYI, I'll probably be implementing a mass export feature for the wiki, > > so you could write a script or something to automate an import. > > > Awesome work, Zack. > > > Justin > > > On Jul 9, 2:25 pm, Alex Miller <alexdmil...@yahoo.com> wrote: > >> 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://clojure.... > >>> 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 -- 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
