cljsinfo / cljs.info

ClojureScript website
http://cljs.info
MIT License
96 stars 9 forks source link

improve docs #45

Closed oakmac closed 9 years ago

oakmac commented 9 years ago

The following docs have TODOs in them and need to be reviewed / improved.

# grep -Irl "TODO" .
./cljs.core_-GT.cljsdoc
./cljs.core_-GTGT.cljsdoc
./cljs.core_apply.cljsdoc
./cljs.core_as-GT.cljsdoc
./cljs.core_comp.cljsdoc
./cljs.core_def.cljsdoc
./cljs.core_doall.cljsdoc
./cljs.core_doseq.cljsdoc
./cljs.core_fn.cljsdoc
./cljs.core_for.cljsdoc
./cljs.core_identity.cljsdoc
./cljs.core_ns.cljsdoc
./cljs.core_partition.cljsdoc
./cljs.core_take-last.cljsdoc
./cljs.core_to-array-2d.cljsdoc
./cljs.core_when-first.cljsdoc
oakmac commented 9 years ago

Maybe @imalooney can assist?

NPrescott commented 9 years ago

Because manually navigating to those is hard: TODO in path:/docs

Do you have a designated location for the threading macro animation yet? Several issues call for a link but I don't know that there's a permanent home yet.

NPrescott commented 9 years ago

The more I think about it, as a community project (ostensibly) how is cljs.info addressing the overlap with projects like Grimoire - Clojure Documentation or even the Clojure Docs themselves? Each is Clojure specific (rather than Clojurescript) but contains many community contributed examples already. Should we just lift examples from there? Should we ask that people contribute to both places?

Specifically I'm looking at the apply docs calling for examples, when this already exists.

oakmac commented 9 years ago

My initial thinking was to copy the best examples that already exist (ie: clojuredocs, grimoire, etc) and then edit / curate.

I think the examples should be stored in simple text files similar to the cljsdoc files (maybe inside the existing cljsdoc files as a new section?)

The editing / curation part will be the most important.

oakmac commented 9 years ago

re: the threading macro animation links

The threading macro animations project is still a work in progress. I plan to update those docs when the site is ready.

shaunlebron commented 9 years ago

I'm going to close this issue here. Some points:

screen shot 2015-07-27 at 3 23 01 pm