> Like this?  http://brighterplanet.github.com/flight/impact_model.html

> You can see how they handle it (from a Ruby-centric perspective) here: 
> https://github.com/brighterplanet/numbers/blob/gh-pages/_posts/2010-12-02-github-pages-rocco-and-rake-file-tasks.markdown

(The original thread seems to have disappeared; it can be found here:
http://groups.google.com/group/clojure/browse_thread/thread/7f31a8e7aa98a547/5562eb25b9d70365?lnk=gst&q=Lithub#5562eb25b9d70365.)

This does seem to be a good way of doing a Lithub.  For that matter,
there is the recent release of Clojure fs utils with Marginalia docs
at http://raynes.github.com/fs/

I'd say this kind of thing needs really only two steps to be a full
Lithub.  One, this should be the \main way of viewing code, i.e. in
place of https://github.com/Raynes/fs.  There does seem to be a
certain amount of customization of Github possible from the
Brighterplanet example, so maybe a Marginalia-centric Lithub within
Github is possible.  Maybe it would even be possible to give three
views of the same material: code and docs side-by-side, docs with
links to code, and vice-versa.

The second step is a matter of search-engine optimization----something
I know very little about, I have to admit.  Look at this line in the
fs utils Marginalia, for instance:

Return the base name (final segment/file part) of a path.

(defn base-name
  [path]
  (.getName (file path)))

All the keywords you need to find that function are there; it even
provides three alternatives!  If I were searching off the top of my
head, I'd probably Google: return file part of path in Clojure.  But
this returns a mess of links that don't really lead to that function;
the Marginalia line doesn't even show up in the first few pages of
results (granted, it's fairly new).

Imagine if that kind of thing \were the first link, every time.
Consider how much time people spend every day looking for library
functions----any improvement in that process would be a big
productivity and coding-flow gain.  Having independent HTML anchors
for each function in a Marginalia page would be a start----much
simpler than convincing Google to rank specific functions first.  If
the Google-whispering proves to be too difficult, the next best thing
would be optimizing search within the Lithub sites, so that the top
links are always to Clojure library functions and how to call them,
without any distraction.

-- 
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

Reply via email to