Skip to content

docs: link previews with the site's PNG card - #68

Merged
timtreis merged 1 commit into
mainfrom
docs-link-preview
Nov 5, 2026
Merged

timtreis merged 1 commit into
mainfrom
docs-link-preview

Conversation

@timtreis

@timtreis timtreis commented Nov 5, 2026

Copy link
Copy Markdown
Member

Slack previews of the docs showed no image, because og:image was the SVG logo and Slack doesn't render SVG. The description was also cut mid-word at 200 characters.

Changes in docs/conf.py:

  • ogp_image is the website's 1200×630 PNG card, {SITE_URL}/og.png. It follows SITE_URL, so it moves to www with it, and the site-URL test still finds a single source. The card is added to the site in theislab/spatialdata-db-web#81, so merge this after that PR deploys.
  • ogp_image_alt, ogp_site_url (https://spatialdata-db.readthedocs.io/en/latest/) and ogp_description_length = 150.
  • twitter:card is summary_large_image, added as a custom tag, because sphinxext-opengraph doesn't emit it.

Changes in docs/index.md: an explicit og:description for the home page, in whole sentences (125 characters), "A catalog of public spatial omics datasets as SpatialData Zarr stores, with a Python client to query, download and load them." Other pages keep the automatic 150-character cut.

Checks: 458 tests pass. The docs build passes, and the built index.html carries og:image, og:image:alt, twitter:card and the new og:description.

@codecov

codecov Bot commented Nov 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.67%. Comparing base (7170bfe) to head (445061f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   94.67%   94.67%           
=======================================
  Files          22       22           
  Lines        2291     2291           
=======================================
  Hits         2169     2169           
  Misses        122      122           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit f4aae3a into main Nov 5, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant