clojure-doc

Bob B 2023-08-01T03:39:23.761759Z

qq about the 'cookbook' pages: I started doing a first draft of a 'vector' section of the data structues cookbook. I initially went very basic (e.g. covering get and nth), somewhat based on the string cookbook. However, it occurs to me that there's some overlap with the 'data structures' section in the Intro to Clojure page. Would it be better to constrain the cookbooks to 'recipes' that go beyond the scope of "long docstrings with examples", and maybe just mention in the intro "if you're just getting started, the intro sections are a better starting point" (with links, of course)?

Bob B 2023-08-01T03:49:10.010569Z

I'm maybe oversimplifying a bit - I'm thinking about maybe dropping the content on get, nth, conj, into... the super-common ones, but maybe leaving in what I think are more esoteric functions/use cases (e.g. using pop and peek on a vector), and definitely hitting on idioms like "`contains?` probably isn't what you want for a vector, use some with a set"

seancorfield 2023-08-01T04:01:28.824179Z

Good observation, yes, I would prefer a brighter line between the tutorials (covering the basics) and the cookbooks (showing how to build more complex/advanced stuff).

seancorfield 2023-08-01T04:03:29.818969Z

Part of what I was supposed to be working on this period (July/August) was reviewing the ecosystem and tutorials sections and then dealing with cookbooks in the next period and language in the final period... but now you have me rethinking that...

seancorfield 2023-08-01T04:03:46.844989Z

Maybe I should do language first, then tutorials, then cookbooks?

seancorfield 2023-08-01T04:05:41.960239Z

I've been pretty distracted this month -- my mum, mentioned in a couple of my long-term funding update posts, passed away early in July (on my birthday!) and I've been dealing with that on and off (in England, 5,500 miles away) most of this month. Her funeral was Wednesday last week and I think everything is squared away with her husband at this point (he's wreck -- worse than me).

Bob B 2023-08-01T04:11:49.266199Z

I'm sorry to hear that - I don't want to be a distraction/disturbance to handling important stuff.

seancorfield 2023-08-01T04:12:15.357129Z

Nah, it's all handled at this point. Life must go on.

seancorfield 2023-08-01T04:13:25.895359Z

Sounds like I might need to add some more guidelines for contribution... I'll create an issue for that...

Bob B 2023-08-01T04:20:19.377859Z

I guess two factors come to mind immediately with ordering sections: how rapidly sections will evolve, and how much they're already covered - tutorials will probably be fairly static (the fundamentals aren't going to change very often), but there are also probably tens to hundreds of tutorials, where there might be less extant material that's trying to aggregate ecosystem, and new libraries are releasing daily. So maybe (just a proposal) ecosystem is a good first hit, and that might trigger library authors to contribute. Then some more 'static' content, and the occasional 'did anything big change?' on ecosystem.

Bob B 2023-08-01T04:23:12.496229Z

I like the guidelines listed in that issue, I feel like it draws some nice lines to facilitate wider contribution without as much burden on you for "where should I put this?" and similar

seancorfield 2023-08-01T04:25:30.537429Z

Ecosystems has been a bit of a graveyard, unfortunately. The main elements were java.jdbc docs (a library long-since superseded), core.typed (outdated), and various editor guides (also outdated). A lot of it has been deleted since it was so outdated. I'd love to see people contribute but... Best I can do is point to http://clojure.org material and Practicalli both of which have better coverage and links.

seancorfield 2023-08-01T04:26:42.118449Z

You're right about a lot of competing tutorials. I'd like to be able to point to the best of them online and only provide somewhat novel material on http://clojure-doc.org. I think the cookbooks section is the area that is the most unique.

seancorfield 2023-08-01T04:27:23.030219Z

The language section is mostly just basics and somewhat duplicated elsewhere (although I haven't reviewed it yet). But it does have the advantage of interactive examples via Klipse 🙂

Bob B 2023-08-01T04:33:29.157729Z

I agree about the cookbooks - I have the 'Clojure Cookbook' book (along with way too many other Clojure books), and a lot of the recipes are about using libraries (not a complaint, just an observation). I like the idea of capturing the idioms and common questions (why does any? exist? why is there doall and dorun and doseq and run!?)

seancorfield 2023-08-01T04:34:00.108309Z

Yes! The things that tutorials rarely cover 🙂

Bob B 2023-08-01T04:36:15.528779Z

I have those things in a file called 'blog ideas', but I definitely think putting them somewhere that's central and combined with lots of other info can maybe make it another good reference site.

seancorfield 2023-08-01T04:37:06.674999Z

I could add a section called "Bob's Blog" 🙂

Bob B 2023-08-01T04:39:04.813759Z

oh, I prefer it being "community docs"

😁 1
Bob B 2023-08-01T04:50:36.164729Z

you've got my brain brewing now... I wonder if those sorts of things would fit into an "FAQ", but I guess that would lead to http://ask.clojure.org.... although maybe summarizing some of the conversation threads would make them more palatable

Bob B 2023-08-01T04:51:29.252939Z

that almost certainly needs some hammock time - I'll work on the data structures cookbook before worrying too much about trying to add new stuff

👍🏻 1