docs: SPARROW ecosystem alignment — MkDocs site, citation, issue templates, branding#51
Open
rain-Brian wants to merge 3 commits into
Open
docs: SPARROW ecosystem alignment — MkDocs site, citation, issue templates, branding#51rain-Brian wants to merge 3 commits into
rain-Brian wants to merge 3 commits into
Conversation
…randing fixes - Add MkDocs docs site (mkdocs.yml, docs-requirements.txt, deploy-docs.yml) - Add docs/ with 6 pages: index, hardware, setup, cite, tags, build_mkdocs - Add citation.cff (16 authors, software citation) - Add .github/ISSUE_TEMPLATE/ (bug-report, feature-request, question) - Fix SUPPORT.md: replace TODO placeholders with real support guidance - Fix README.md: hero image alt text, PyTorch-Wildlife branding, ecosystem table - Add site/, archive/, *.code-workspace to .gitignore
- index.md: add architecture diagram, capabilities table, use-case summary - hardware.md: full BOM component tables by category (Jetson, solar, Starlink, AudioMoth, camera) - setup.md: setup script step table, folder layout, AI models (Triton/ONNX), Docker services detail, dashboard links
File contained only a blank line and had a typo in the filename (piplines).
zhmiao
approved these changes
May 15, 2026
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
2 participants
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.
Summary
mkdocs.yml,docs-requirements.txt, anddocs/with 6 pages (index, hardware setup, software setup, cite, tags, developer guide) — all with SEOdescription+tagsfront matter;mkdocs buildpasses clean.github/workflows/deploy-docs.yml— auto-deploys to GitHub Pages on push tomain(triggers ondocs/**,mkdocs.yml,docs-requirements.txt)citation.cff: Software citation with all 16 authors from the SPARROW paperbug-report.yml,feature-request.yml,question.yml(.github/ISSUE_TEMPLATE/)SUPPORT.md: Replaced TODO placeholder content with real support guidance (GitHub Issues + Discussions)README.md: Hero image alt text added;PyTorch Wildlife→PyTorch-Wildlife(line 40 prose); Biodiversity ecosystem table added.gitignore: Addedsite/,archive/,*.code-workspacePost-merge steps (manual — requires org admin)
https://microsoft.github.io/SPARROW/sparrow,edge-ai,camera-traps,wildlife-monitoring,conservation,ai-for-good,jetson,docker,solar-powered,pytorch-wildlifeTest plan
mkdocs buildpasses with no errors (verified locally)citation.cffrecognized by GitHub "Cite this repository" button