docs(seo): SPARROW structured-data + social + self-hosted assets parity#62
Open
rain-Brian wants to merge 3 commits into
Open
docs(seo): SPARROW structured-data + social + self-hosted assets parity#62rain-Brian wants to merge 3 commits into
rain-Brian wants to merge 3 commits into
Conversation
Add SEO infrastructure to the SPARROW docs site, mirroring the merged microsoft/Biodiversity pattern: - overrides/main.html: SoftwareSourceCode JSON-LD on the homepage and a BreadcrumbList on every other page (gated on page.file.src_path so the schema cannot leak between pages), plus Open Graph and Twitter Card meta with an absolute share-image URL. - Self-host the favicon and logo at docs/assets/cat.png, dropping the Zenodo cross-origin references. - Add the callouts and git-revision-date-localized plugins (with fetch-depth: 0 on the docs-deploy checkout so commit dates resolve).
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
1 participant
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.
Replicates the merged microsoft/Biodiversity#653 SEO infrastructure pattern for the SPARROW docs site. Part of ADO Epic 506340 (Phase 1 repo on-page SEO).
What changed
overrides/main.html, newtheme.custom_dir: overrides):SoftwareSourceCodeJSON-LD on the homepage and aBreadcrumbListon every other page. Both are gated onpage.file.src_path, which is unique per page, so a schema block cannot be copied between pages by accident.{site_url}assets/cat.png).docs/assets/cat.pnginstead of the Zenodo URL, removing a cross-origin dependency.callouts(first plugin) andgit-revision-date-localized(withenable_creation_dateandfallback_to_build_date); listed both indocs-requirements.txt. The docs-deployactions/checkout@v4step now setsfetch-depth: 0so the revision-date plugin can read full git history.Keywords in the JSON-LD target SPARROW's lane in the cluster keyword-ownership matrix (solar-powered edge AI, NVIDIA Jetson camera trap, Starlink wildlife, bioacoustic edge device), avoiding overlap with the MegaDetector and PyTorch-Wildlife repos.
Notes
FAQPageschema is included.mkdocs build --strictpasses cleanly. Verified the builtsite/index.html: homepage title renders, both JSON-LD blocks parse as valid JSON (SoftwareSourceCodeon index,BreadcrumbListon sub-pages), zero remaining Zenodo references for theme assets, and OG/Twitter meta carry the absolute image URL.