Skip to content

docs(seo): hub structured-data + social + self-hosted assets parity#653

Open
rain-Brian wants to merge 3 commits into
mainfrom
seo/hub-infra-structured-data
Open

docs(seo): hub structured-data + social + self-hosted assets parity#653
rain-Brian wants to merge 3 commits into
mainfrom
seo/hub-infra-structured-data

Conversation

@rain-Brian
Copy link
Copy Markdown
Collaborator

What

Brings the Biodiversity hub to the MegaDetector docs gold standard at the infrastructure / structured-data layer (first of two hub PRs; the content/cohesion PR follows).

Changes

  • Structured dataoverrides/main.html with Organization JSON-LD (the AI for Good Lab Biodiversity initiative) + an ItemList of the cluster's four documentation sites (the entity anchor that ties the cluster together for search), BreadcrumbList on interior pages, and a clean homepage <title>. Both JSON-LD blocks validated as well-formed.
  • Social — Open Graph + Twitter Card meta with an absolute local share image.
  • Performance — self-hosted favicon/logo + homepage banner in docs/assets/ (drops cross-origin Zenodo requests on render-blocking assets).
  • Metadata correctnesssite_description and the homepage description described PyTorch-Wildlife and carried the deprecated "SPARROW Studio" name; both now describe the hub and target its umbrella keywords (Microsoft biodiversity AI, open source conservation AI).
  • Freshnessmkdocs-callouts + git-revision-date-localized plugins (+ deps) and fetch-depth: 0 in the deploy workflow so last-updated dates render.

Verification

  • mkdocs build succeeds; homepage emits 2 valid JSON-LD blocks (Organization + ItemList×4), OG/Twitter tags with absolute image URL, interior BreadcrumbList, and last-updated dates render.
  • No em-dashes in added prose.
  • Note: --strict is not used as a gate here because the repo's baseline already trips 2 pre-existing griffe/mkdocstrings docstring warnings in PytorchWildlife source, unrelated to this change.

Scope notes

  • Three Zenodo example images remain in the homepage body (below-the-fold, not render-blocking); they can be self-hosted in the follow-up content PR.
  • Part of the cluster SEO-parity work tracked under ADO Epic 506340.

Brings the Biodiversity hub to the MegaDetector docs gold standard (infra layer):

- Add overrides/main.html: Organization JSON-LD + an ItemList of the cluster's
  four documentation sites (the entity anchor tying the cluster together for
  search), BreadcrumbList on interior pages, and a clean homepage <title>.
- Add Open Graph + Twitter Card meta with a local share image.
- Self-host favicon/logo and the homepage banner in docs/assets/ (drop the
  cross-origin Zenodo requests on render-blocking assets).
- Fix site_description and the homepage description: they described
  PyTorch-Wildlife and carried the deprecated "SPARROW Studio" name; they now
  describe the hub and target its umbrella keywords.
- Add mkdocs-callouts and git-revision-date-localized plugins (+ deps) and set
  fetch-depth: 0 in the docs deploy workflow so last-updated dates render.

Part of the cluster SEO-parity work (ADO Epic 506340).
Per external schema review: model the homepage as WebSite + CollectionPage
(the page's main entity is the project collection, not the Lab) + Organization
(the Lab as publisher) + ItemList of the four sub-sites, cross-linked by @id.
Add sameAs (GitHub) and og:image:alt. Banner swap to a 1200x630 image is a
tracked design dependency.
@rain-Brian rain-Brian requested a review from zhmiao June 3, 2026 22:22
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