On Jun 25, 12:52 am, Vinzent <[email protected]> wrote: > It's a great initiative indeed, but I found the project pretty useless in > its current state. Forking the repo and sending a pull request just to add > an example is painful.
Hm. Thanks for the feedback. > Also, I can read rendered readme on github (and have > the source code at hand), so why go to another site? 1. centralized location for docs (easy to find your way to other project docs) 2. the examples 3. more featureful rendering (I'm using Pandoc for the alcove, and so it supports extra markdown syntax for things like tables, definition lists, LaTeX math, and a few other goodies.) > I think what would be really good is the possibility to add user projects > to clojuredocs.org. That would be nice. > Every user who has an account should be allowed to add > his own project, which will reuse all the clojuredocs infrastructure > (comments, examples, links to the source). Readme and stuff like links to > clojars and github pages could be displayed on the project's main page. > > However, there is a little problem with that: clojuredocs is written in > RoR, AFAIK. What about rewriting it in clojure+clojurescript, anybody? :) I'm also curious about this. > As for non-API part of documentation, I think github's wiki is pretty good > for this purpose. I'd personally won't use another site which provides > similar functionality just because it was created specifically for clojure > projects. That's true. The github wiki's could be used for example code too. Though, I don't see it used much for that. Perhaps a dedicated site like the alcove would encourage more contributions of example code? Also, I think there's something to be said for having all the examples in one place --- one repo that anyone can grab and have the full collection. (Though, perhaps clojuredocs.org could support that too.) If clojuredocs.org were to be extended to support adding 3rd-party projects, would users prefer to put example code there, or in the project's github wiki? Thanks for the feedback. ---John -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to [email protected] Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/clojure?hl=en
