Received: by 10.224.6.142 with SMTP id 14mr525991qaz.7.1278716026756;
        Fri, 09 Jul 2010 15:53:46 -0700 (PDT)
X-BeenThere: clojure@googlegroups.com
Received: by 10.224.88.4 with SMTP id y4ls123179qal.7.p; Fri, 09 Jul 2010 
	15:53:41 -0700 (PDT)
Received: by 10.224.11.2 with SMTP id r2mr431038qar.19.1278716021554;
        Fri, 09 Jul 2010 15:53:41 -0700 (PDT)
MIME-Version: 1.0
Received: by 10.100.235.38 with SMTP id i38mr1083440anh.7.1278708933395; Fri, 
	09 Jul 2010 13:55:33 -0700 (PDT)
Received: by 41g2000yqn.googlegroups.com with HTTP; Fri, 9 Jul 2010 13:55:33 
	-0700 (PDT)
Date: Fri, 9 Jul 2010 13:55:33 -0700 (PDT)
In-Reply-To: <ffee1895-8625-4ed8-aba8-a8ef8197421f@x1g2000prc.googlegroups.com>
X-IP: 69.140.238.182
References: <ffee1895-8625-4ed8-aba8-a8ef8197421f@x1g2000prc.googlegroups.com>
User-Agent: G2/1.0
X-HTTP-UserAgent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; en-us) 
	AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16,gzip(gfe)
Message-ID: <0f827eee-e365-4bea-ac87-4d28d9497190@41g2000yqn.googlegroups.com>
Subject: Re: ClojureDocs.org
From: John Cromartie <jcromar...@gmail.com>
To: Clojure <clojure@googlegroups.com>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

Beautiful. I think this should become the official community place for
Clojure docs. Now who wants to integrate my :examples defn attribute
code :)

-John

On Jul 9, 4:32=A0am, 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. =A0It'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). =A0Looking 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! =A0There'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. =A0I'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). =A0Probably 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. =A0I'm also considering
> setting up a google group for general discussion. =A0Feel free to
> contact me directly through email.
>
> Questions / thoughts?
>