docs: simplify hydrologist-facing documentation (milestone m1)#27
Merged
Conversation
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
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.
docs: simplify hydrologist-facing documentation (milestone m1)
What changed
mkdocs.ymlwith syntax highlighting, a code-copy button, and a light/dark palette for the docs site.docs/how-it-works.mdaround precomputed catchment connections and the plain watershed framing.docs/basin-geoparquet-export.md.crates/python/README.mdto a quickstart and moved pyshed tuning knobs intocrates/python/API.md.README.mdfor hydrologists, centered the pitch on giving shed a point on a river and getting the whole upstream area that drains to it, and switched install instructions touv add pyshedwith a pip fallback.docs/index.md,docs/quickstart.md,docs/guide/datasets.md, anddocs/credits.mdto the same plain-language watershed framing.Why
This milestone makes the docs easier to read for hydrologists evaluating shed. The new framing is direct: give shed a point on a river and it returns the whole upstream area that drains to it, the watershed.
The campaign also removes unsupported performance numbers, removes HDX from user-facing docs, and keeps advanced pyshed tuning details out of the PyPI README so the package page stays focused on installation and first use.
No version bumps and no tags are included, following the curated-release policy.
Verification
main..milestone-m1: six squash-merged step PRs, docs(site): enable syntax highlighting, code copy button, and light/dark palette #21 through docs(site): align index, quickstart, datasets, and credits to plain watershed framing #26.README.md,crates/python/API.md,crates/python/README.md,docs/basin-geoparquet-export.md,docs/credits.md,docs/guide/datasets.md,docs/how-it-works.md,docs/index.md,docs/quickstart.md, andmkdocs.yml.