Skip to content

docs(seo): hub umbrella content + front-matter parity#654

Open
rain-Brian wants to merge 2 commits into
seo/hub-infra-structured-datafrom
seo/hub-content
Open

docs(seo): hub umbrella content + front-matter parity#654
rain-Brian wants to merge 2 commits into
seo/hub-infra-structured-datafrom
seo/hub-content

Conversation

@rain-Brian
Copy link
Copy Markdown
Collaborator

What

Additive content layer for the Biodiversity hub (stacked on the infra/schema PR #653; base will retarget to main when #653 merges).

New pages

  • docs/ecosystem.md — the ecosystem directory + a "which project should I use?" decision guide, with topic-specific anchors linking out to each project's documentation site (MegaDetector, MegaDetector-Acoustic, SPARROW, PyTorch-Wildlife). Targets the hub's umbrella keywords (Microsoft biodiversity AI, open source conservation AI). Cluster-cohesion win.
  • docs/ecosystem-standards.md — the shared documentation standards every ecosystem repo follows (site structure, metadata, structured data, cross-linking, topic ownership), so new repos replicate the gold-standard pattern.

Other

  • Both pages added to nav; homepage now surfaces the ecosystem + collaborators with controlled anchors.
  • title: front-matter added to 10 hand-written pages (front-matter parity).
  • Removed stale "SPARROW Studio" naming and em-dashes from every touched page.

Verification

  • mkdocs build succeeds; both new pages render with correct titles, interior BreadcrumbList, and resolving lane links.
  • Em-dash gate: clean across all 13 touched pages.
  • AI-tells linter: the only flags are pre-existing HTML/markup boilerplate (badge row, banner div, example-image captions, org-list items); the new prose pages are unflagged.

⚠️ Positioning flag for @zhmiao (not addressed here, by design)

The hub repo (microsoft/Biodiversity) hosts the PytorchWildlife package + setup.py and its homepage is titled "Welcome to PyTorch-Wildlife", while a separate microsoft/Pytorch-Wildlife repo also embodies the framework. This creates a hub-vs-sub-repo identity overlap and "PyTorch Wildlife" keyword cannibalization. Reframing the hub homepage as a pure umbrella is deferred pending a team decision on which repo owns the framework identity. This PR is additive only and does not touch that positioning.

Part of the cluster SEO-parity work (ADO Epic 506340).

Additive content for the cluster hub (homepage repositioning intentionally NOT
touched; see PR notes for the Biodiversity-vs-Pytorch-Wildlife positioning flag):

- New docs/ecosystem.md: the ecosystem directory + a "which project should I
  use?" decision guide, with topic-specific anchors linking out to each
  project's documentation site (cluster cohesion).
- New docs/ecosystem-standards.md: the shared documentation standards every
  ecosystem repo follows (structure, metadata, structured data, cross-linking,
  topic ownership) so new repos replicate the pattern.
- Add both to nav; surface the ecosystem + collaborators from the homepage.
- Add title front-matter to 10 hand-written pages; remove stale "SPARROW Studio"
  naming and em-dashes from touched pages.

Part of the cluster SEO-parity work (ADO Epic 506340).
…RL is stable

Per SEO review: the hub should not link to Acoustic's canonical URL while it
301-redirects (repo private, Pages on a randomized URL). Name it as 'documentation
coming soon' without the live link in the ecosystem directory and the topic-ownership
table; re-add the link once the repo is public and the URL returns 200.
@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