cljdoc

2024-10-05T02:29:13.806739Z

is it possible to force cljdoc to render API docs of a given namespace in definition order instead of alphabetical order?

martinklepsch 2024-10-05T10:43:12.309709Z

no, we discussed this at some point but overall I felt like the alphabetical order would provide a more consistent experience for readers

martinklepsch 2024-10-05T10:44:07.044259Z

i get why you want it though, maybe a namespace docstring using [[wikilinks]] could guide a user to read things in a certain order?

2024-10-05T12:56:29.678799Z

dang, okay

2024-10-05T12:56:35.308429Z

would you accept a patch to support it? or nah

martinklepsch 2024-10-05T12:57:26.574589Z

I was thinking about that, but I'd like that to be a switch in the UI rather than per project if that makes sense?

2024-10-05T12:58:08.121059Z

i can write an md file to document these items in logical order, this just seemed the easiest way to say "these things are all in one namespace but each subset is grouped semantically"

lread 2024-10-05T13:58:12.557389Z

@nbtheduke, only one other person (that I know of) has asked for this. My thought is the API docs are an index of vars that folks expect to be ordered alphabetically. My feeling is a user guide is the place to describe the semantics and groupings. That said, I do maintain a couple of projects that have kitchen sink APIs. For these, I provide a secondary index in the namespace docstring that provides the grouping you might be thinking of: • https://cljdoc.org/d/rewrite-clj/rewrite-clj/1.1.48/api/rewrite-clj.ziphttps://cljdoc.org/d/etaoin/etaoin/1.1.42/api/etaoin.api This has worked for me; perhaps it could work for you too.

👍 1
2024-10-05T19:41:27.557569Z

oh wow, is that all in the docstring? that's clever. i'll borrow that for lazytest

lread 2024-10-05T19:54:47.881689Z

Yep, I maintain the ns docstring index manually, which can be a bit of a pain to remember to update, but it works well enough.

danieroux 2024-10-05T07:54:17.202899Z

Anyone else not able to get there?

$ curl 
curl: (7) Failed to connect to  port 443 after 187 ms: Couldn't connect to server

danieroux 2024-10-05T07:55:08.180019Z

I declare a hiccup 😊

lread 2024-10-05T08:15:06.652869Z

hmmm… I do see some ups and downs… will have to look into cause

danieroux 2024-10-05T08:30:29.422809Z

It's up for me again 👍

borkdude 2024-10-05T08:54:28.254559Z

👍

martinklepsch 2024-10-05T16:51:42.024139Z

Hey all — I recently remembered that cljdoc has an https://opencollective.com/cljdoc with ~$1400 in the bank. 🤑 I decided to donate $500 of that to @lee as a token of gratitude. gratitude For his many contributions to cljdoc and, in many ways, stewardship of the project the last 3+ years. Thanks Lee, you are awesome! It's been lovely to see so many of you contribute to the OpenCollective over the years and I hope you all celebrate this decision 🤗 ❤️

3
❤️ 3
lread 2024-10-05T16:54:33.508259Z

Thanks, @martinklepsch, and OpenCollective contributors! My frugally retired ass appreciates all donations and contributions! simple_smile

lread 2024-10-05T16:52:14.044989Z

I think I might have addressed hiccup 1 of n (when n is hopefully 1!) by giving some more RAM to one of our services. Let us know if you have any more issues.

1
lread 2024-10-05T21:56:14.517679Z

I upgraded the cljdoc-analyzer build job from JDK21 to JDK23. This will allow libs that depend on JDK22+ features to pass cljdoc API analysis.

🎉 1