Very nice work.

I've recently done something similar, by adding to http://crossclj.info the 
ability to navigate auto-generated docs from docstrings and metadata.

The user interface balance is a bit different, the navigation is by 
namespace or by project, for example:

http://crossclj.info/doc/org.clojure/clojure/1.6.0/clojure.string.html

you see all the docs for the whole namespace, and you can jump to the 
source of a function (within the whole namespace source).

you can navigate the namespace hierarchy and switch from source to docs 
view using the control on the top left 

There is no way to add examples, but you can search for usages from all the 
indexed open source projects, which is usually pretty effective (you can 
try by clicking on one of the Usages link in the page above).

The auto generated doc is available and cross-referenced not only for the 
clojure standard lib, but also for all the indexed open-source projects 
(you can search them from the home page, or by navigating the references in 
the sources), although with different quality and coverage levels, due to 
some practical issues in working with arbitrary sources.

Other examples:
http://crossclj.info/doc/instaparse/1.3.2/instaparse.core.html
http://crossclj.info/doc/clj-time/0.7.0/clj-time.core.html

Overall, I think it's useful and enriching to see different UI approaches 
at work.

Francesco




On Wednesday, July 2, 2014 1:34:38 AM UTC+2, Reid McKenzie wrote:
>
> Hey guys, 
>
> If you're like me while using clojure.repl/doc works for the most part 
> there are just times that you need to send someone a link to the 
> official docs and navigating the docstrings in the core Clojure 
> repository is a pain. 
>
> After several months of being frustrated that clojuredocs is out of 
> date, I finally sat down and built an alternative which I'm pleased to 
> present here: http://www.arrdem.com/grimoire/ 
>
> Grimoire is still alpha and subject to change, especially with regards 
> to the example contribution process which needs streamlining beyond the 
> current "click a link, edit on github and submit a PR". 
>
> I'd like to give a shout out to César for porting clojure.repl/source 
> into the doc generation script and to Nicola for his random usability 
> criticisms. 
>
> Reid McKenzie 
>

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

Reply via email to