The discussion revolves around making the SunPy documentation compatible with Discourse’s onebox previews. Wall-E seeks guidance on what makes a site compatible with onebox, noting that SunPy uses Sphinx for documentation. Falco explains that the current page lacks a proper description OpenGraph tag and uses relative URLs, which prevents onebox from working. Wall-E shares that the SunPy team attempted a fix, with OpenGraph tags validated by opengraph.xyz, but the issue persists. codinghorror points out that the description is too generic, and riking clarifies that the description must be a meaningful excerpt from the content, not identical to the title, for onebox to work.
If you try to link https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html in a line by itself you will see this message:
Sorry, we were unable to generate a preview for this web page, because the following oEmbed / OpenGraph tags could not be found: description, image
That page has an empty description OpenGraph meta tag, so we can’t embed it. It also uses relative URLs for some other OpenGraph tags, like image and url which I’m not sure it’s supported.
So I forwarded the info to the SunPy dev team. They tested a fix with this page: https://sunpy--5366.org.readthedocs.build/en/5366/, it was validated by opengraph.xyz, saying that all tags are defined in the html file:
Is that an actual entry? The description should be longer, and contain a subset of the actual content on the page, not a placeholder like “SunPy Documentation”.
The description is being ignored because it’s identical to the title. You should be excerpting relevant parts of the content into the description property.