cljdoc 2024-02-29

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?

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

I deleted a previous version ๐Ÿ™‚

๐Ÿ‘ 1

on documentation we could display the number of contributors?

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

oh, duh, ok!

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.

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

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

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?

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

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.

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

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?

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

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

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?

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

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

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 โค๏ธ )

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

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

๐Ÿ™‚ 1