Skip to content

refactor: rename LICENSE, update citation.cff, and restructure README as ecosystem hub#638

Open
rain-Brian wants to merge 17 commits into
mainfrom
rain-Brian-patch-2
Open

refactor: rename LICENSE, update citation.cff, and restructure README as ecosystem hub#638
rain-Brian wants to merge 17 commits into
mainfrom
rain-Brian-patch-2

Conversation

@rain-Brian
Copy link
Copy Markdown
Collaborator

@rain-Brian rain-Brian commented May 13, 2026

Summary

This PR consolidates the CameraTraps → Biodiversity migration and establishes the README as the hub for the multi-repo ecosystem.

README restructure (absorbs PR #637):

  • Add # Microsoft Biodiversity H1 heading — primary GitHub search signal for the repo
  • Hub framing: points visitors to microsoft/MegaDetector, microsoft/PytorchWildlife, and child repos
  • Projects table with updated naming (MegaDetector-Acoustics, MegaDetector-Overhead)
  • Cleaner Cite, Contributing, and Community sections
  • Updated badges: correct Biodiversity LICENSE URL, proper Discord/Docs badges

LICENSE:

  • Rename LICENSE.mdLICENSE (GitHub recognizes the canonical filename and displays it in the sidebar)
  • Fix copyright string: [2023] [Microsoft]Microsoft Corporation.

citation.cff (absorbs from PR #632):

  • Add citation file enabling GitHub's "Cite this repository" sidebar widget

mkdocs.yml:

  • Update repo references from CameraTraps → Biodiversity

PW_Bioacoustics/README.md:

  • Update install comment: CameraTraps → PyTorch-Wildlife

Test plan

  • Confirm # Microsoft Biodiversity renders as H1 on the repo homepage
  • Verify LICENSE appears in the sidebar (no .md extension)
  • Check "Cite this repository" button appears in GitHub sidebar
  • Spot-check Projects table links resolve correctly
  • Run mkdocs build locally — no new warnings

🤖 Generated with Claude Code

rain-Brian and others added 14 commits May 5, 2026 13:31
Updated the README to reflect the new structure of the repository and added information about biodiversity initiatives.
Updated the README to reflect the new structure of the repository and added information about biodiversity initiatives.
Updated announcements and added new features for Sparrow Studio and PW-Engine.
- Rename LICENSE.md to plain LICENSE file for GitHub recognition
- Update copyright line from placeholder [2023] [Microsoft] to
  standard Microsoft Corporation format
- Aligns with current Microsoft public repository conventions
- SECURITY.md already compliant with v0.0.9 standard

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Transform README from PyTorch-Wildlife-focused to comprehensive ecosystem overview:
- Add Projects table linking all related Microsoft repos (MegaDetector, Bioacoustics,
  Overhead detection, SPARROW, SPARROW Studio)
- Update tagline to reflect full scope: camera traps, bioacoustics, wildlife monitoring
- Consolidate and simplify Announcements section with clearer messaging
- Reorganize badges for better visibility (License, Discord, Docs first)
- Remove duplicate Quick Start/Install sections (now on individual project pages)
- Fix image link syntax and update all deprecated URLs
- Ensure consistent branding (SPARROW Studio, PyTorch-Wildlife hyphenation)
- Add IMPORTANT notice for contact and community info

This positions the Biodiversity umbrella as the entry point while directing users to
project-specific documentation and repositories.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Replace old microsoft/CameraTraps repository references with current
microsoft/Biodiversity in:
- mkdocs.yml repo_url and repo_name
- PW_Bioacoustics README installation instructions

Aligns documentation with repository rename.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@rain-Brian rain-Brian requested a review from zhmiao May 13, 2026 00:17
Copy link
Copy Markdown
Collaborator

@zhmiao zhmiao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we lost the announcement we made before, lol

@rain-Brian rain-Brian requested a review from zhmiao May 13, 2026 04:50
rain-Brian and others added 2 commits May 13, 2026 08:18
Absorbed from PR #637 (brian-patch-2). GitHub indexes the README H1 as
the primary search signal for the repo.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@rain-Brian rain-Brian requested a review from zhmiao May 13, 2026 18:45
@rain-Brian rain-Brian changed the title Update outdated CameraTraps references to Biodiversity refactor: rename LICENSE, update citation.cff, and restructure README as ecosystem hub May 13, 2026
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.

3 participants