cljdoc

martinklepsch 2024-02-29T09:41:45.389369Z

I'm thinking of adding dynamic opengraph images to cljdoc (via an external service), do you think something like the below would be useful in link previews? Am I missing any information we could/should display?

lread 2024-02-29T13:03:10.425209Z

On my slack client I am seeing โ€œ? This file was not found.โ€

martinklepsch 2024-02-29T13:03:34.567499Z

I deleted a previous version ๐Ÿ™‚

๐Ÿ‘ 1
martinklepsch 2024-02-29T09:42:27.578029Z

martinklepsch 2024-02-29T09:47:16.869849Z

on documentation we could display the number of contributors?

lread 2024-03-02T12:48:24.441659Z

@corasaurus-hex I think @martinklepsch was looking for feedback on content and maybe (?) styling.

Cora (she/her) 2024-03-03T01:40:24.549009Z

oh, duh, ok!

Cora (she/her) 2024-03-03T01:43:44.433259Z

I think adding the contributors is a good idea, and maybe github stars if we can get it, and maybe link to the source code like how github's expanded text links to the project's website.

Cora (she/her) 2024-03-03T01:47:17.390819Z

I don't think I have much to add about the styling outside of adding a generic image. you could embed info in the image but if we do we should make sure it doesn't include more info than is present in the text, keeping things accessible is important

Cora (she/her) 2024-03-03T01:51:04.709539Z

I've done this all of one time and probably wouldn't be helpful on the technical front

lread 2024-02-29T13:08:11.471439Z

Sorry havenโ€™t had my first coffee yet! ๐Ÿ™‚ Iโ€™m not clear yet where this is displayed. Is seems like the cljdoc home page but I see reitit?

martinklepsch 2024-02-29T15:26:40.332719Z

ah sorry! So this would be the image that gets autoexpanded in a lot of contexts like Slack, Twitter, etc, whenever a URL is shared. In this case it would be ~for this URL https://cljdoc.org/d/metosin/reitit/0.7.0-alpha7/doc/introduction

lread 2024-02-29T16:18:19.125359Z

Ooooh! I see, tx. So the new info is the contributors count. And the formatting is new. And... the pom description is no longer included.

lread 2024-02-29T16:20:05.330389Z

Are those the contributors to the article or to the GitHub repo?

lread 2024-02-29T16:24:02.976919Z

What does GitHub do? Lessee (for comparison): https://github.com/metosin/reitit/blob/master/doc/README.md

lread 2024-02-29T16:24:35.634939Z

Hmm... nada. Let's try: https://github.com/metosin/reitit

lread 2024-02-29T16:30:48.776129Z

So, I'm not saying we should not make this change, but I am also not sure I see yet the rationale for it. Is it to better promote cljdoc? To look more polished? To more clearly summarize a link?

lread 2024-02-29T16:32:19.157459Z

What does clojars do? Lessee: https://clojars.org/metosin/reitit-core/versions/0.7.0-alpha7

lread 2024-02-29T16:36:03.263479Z

I like clojars summary. I honestly also think the current cljdoc summary is pretty good.

martinklepsch 2024-03-01T22:50:53.416039Z

This is what I see clojars doing, it's not really showing an image at all: https://www.opengraph.xyz/url/https%3A%2F%2Fclojars.org%2Fmetosin%2Freitit-core%2Fversions%2F0.7.0-alpha7

martinklepsch 2024-03-01T22:51:38.269669Z

cljdoc is currently not showing an image at all: https://www.opengraph.xyz/url/https%3A%2F%2Fcljdoc.org%2Fd%2Fmetosin%2Freitit%2F0.7.0-alpha7%2Fdoc%2Fintroduction

martinklepsch 2024-03-01T22:52:51.436779Z

so what I'm suggesting, and maybe this wasn't perfectly clear, is adding OpenGraph images to these urls so that apps like Slack, Telegram, Twitter, Facebook etc. can provider a more rich link preview

lread 2024-03-01T23:39:49.587309Z

So on Slack, things look good to me today. I personally donโ€™t use other social media, but I do understand your rationale for this change now. Iโ€™m probably not a great person to give feedback on this one! โค๏ธ Maybe @corasaurus-hex would have some input?

Cora (she/her) 2024-03-02T01:30:13.388489Z

it's a good thing to do, especially for on twitter where they JUST show that image now and not the title or description. I know sites are pretty aggressive about caching so the images probably won't be as dynamic as you might expect

Cora (she/her) 2024-03-02T01:33:05.160089Z

but i'd be in favor of this change if someone wanted to make it

martinklepsch 2024-03-03T08:30:18.373649Z

Hey Cora! ๐Ÿค— Thanks for your thoughts, any feedback is great really. I was just trying to figure out if it would add value to cljdoc users. As it happens I'm working on a project (dare I say, product) that makes this kind of image generation trivial from an engineering perspective and I'm looking for more places where I can get some real-world testing ๐Ÿ™‚ I'll have a look and open a PR some time (might take a week until I get to it so don't hold your breath please โค๏ธ )

lread 2024-03-03T13:36:11.500239Z

Holy smokes @martinklepsch, you certainly are trickling in the details on this one! ๐Ÿ™‚ Best of luck with your product. โค๏ธ

martinklepsch 2024-03-03T13:50:10.570389Z

Haha yeah, I guess I couldโ€™ve shared a bit more context from the start ๐Ÿ˜…

๐Ÿ™‚ 1