New: code-only examples & examples formatting guide.

5 views
Skip to first unread message

zkim

unread,
Sep 25, 2010, 9:22:10 PM9/25/10
to ClojureDocs.org Discussion Group
Hey All,

I've just pushed a change that removes the ability to use markdown to
format examples. From this point forward var examples are code only.

The reasoning behind this is that code only examples are easier to
consume through the REPL, or IDE tooling. This change will also help
with eventual automatic validation and reference analysis for
examples. It was a tough decision to get rid of the ability to do
advanced formatting in examples, but I think the pros outweigh the
cons.

Along with this change I've published the set of style guidelines
we've been working on, which can be found here: http://clojuredocs.org/examples_style_guide

Going forward please follow these guidelines when submitting
examples. Also, please voice any opinions you may have on the guide's
content.

A couple of minor changes as well:
* Ajaxified examples editing / submission. Submitting an example no
longer refreshes the page, your new example is inserted directly into
the DOM.
* Added a datetime range search option to the management console:
http://clojuredocs.org/management/search/Clojure%20Core, which I'll be
using over the next few days to bring the current examples up to date.
* Ongoing codebase cleanup to prep for beta.

Thanks, Zack.
Reply all
Reply to author
Forward
0 new messages