Documenting the "Clojure way" of using FW/1 3.5?

[Sean Corfield]

Whilst I’ve created a placeholder for FW/1 3.5’s documentation, I have a question for y’all on how best to document the Clojure integration / Clojure controllers and services approach. The base docs are here:

http://framework-one.github.io/documentation/3.5/

They’re currently just a copy of the 3.1 docs.

In FW/1 3.5, there’s a new example 6helloclojure which is sort of a follow-on to 5helloservice but uses Clojure for controllers and services. So in reality, it’s quite a jump from 5helloservice (and I’d originally called it just helloclojure and may rename it back to that):

https://github.com/framework-one/fw1/tree/clojure/examples/6helloclojure

I was initially thinking of just making the Clojure version a progression in Getting Started but then realized most people won’t go down that route. So I’m thinking of a separate document / page which takes you from zero to full Clojure + CFML FW/1 app.

I’d like input from y’all on what sort of stuff you’d like to see in such a document, and where you’d like to see cross-references between the "regular" FW/1 docs and this Clojure-specific document?

As a bit of background, here’s a blog post that briefly outlines how I started on that helloclojure example:

http://framework-one.github.io/blog/2015/01/25/fw1-clojure-sitting-in-a-tree/

Also bear in mind there’s a pure-Clojure version of FW/1 which is only documented in its own repo at the moment:

https://github.com/framework-one/fw1-clj

That needs documenting as part of the core FW/1 family so I’d like some guidance on how best to organize things so that they serve both the pure-CFML community, the pure-Clojure community, and the hybrid CFML/Clojure folks.

Sean Corfield -- (904) 302-SEAN
An Architect's View -- http://corfield.org/

"Perfection is the enemy of the good."
-- Gustave Flaubert, French realist novelist (1821-1880)