Repository navigation
docs: link previews with the site's PNG card - #68
Merged
Merged
Conversation
… page description
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_imageis the website's 1200×630 PNG card,{SITE_URL}/og.png. It followsSITE_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/) andogp_description_length = 150.twitter:cardissummary_large_image, added as a custom tag, because sphinxext-opengraph doesn't emit it.Changes in
docs/index.md: an explicitog:descriptionfor 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.