Hacker News new | past | comments | ask | show | jobs | submit login

Did you use http://clojure.org/cheatsheet ? I think it's helpful for discoverability.



I eventually found the cheatsheet and it remains useful to this day. But, my specific point was trying to dissect what survey respondents were looking for when asking for more documentation, because each item I listed has a different possible solution.

Documenting function inputs and outputs could use core.typed's annotations to enhance the docs.

Documenting expected behavior leans towards adding content and examples, where the examples can be manually curated or pulled from available opensource code. (Similar to getclojure.org, but bigger.)

Solving bad discovery could be approached by improving the search/organization/unification of the clojure.github.io, the cheatsheet, clojuredocs.org, clojure-toolbox.org and clojure-doc.org.

So, what did they want exactly?


Totally agreed on the question. I have been trying to engage people more actively in the details of this question as well.

There are actually many, many documentation resources right now (seemingly enough for anyone to get started), so the question is really whether actual docs are lacking or just the right place(s) to start for specific kinds of docs.




Consider applying for YC's Spring batch! Applications are open till Feb 11.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: