docs(site): align index, quickstart, datasets, and credits to plain watershed framing#26
Merged
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(site): align index, quickstart, datasets, and credits to plain watershed framing
What changed
docs/index.md: leads with watershed framing, uses the required HFX plain-language phrase, switches install touv add pyshedwith a pip fallback, and updates navigation blurbs without em dashes.docs/quickstart.md: switches install guidance, softens first-open guidance, adds the required repeated-delineation sentence, and explains the already-computed connections workflow.docs/guide/datasets.md: describes HFX as a folder of pre-built river-network files, replaces remote-read jargon with plain network-fetch language, and preserves hosted GRIT attribution plus the D8-raster fact.docs/credits.md: keeps Heberger credit, citations, BibTeX, and lineage while removing outdated how-it-works wording, em dashes, and contrastive-negation phrasing.Why
These hydrologist-facing pages need to echo the rewritten
how-it-works.mdframing:
shedreturns a watershed by looking up already-computed catchmentconnections and merging the upstream units. The edits also apply the campaign
style rules for simpler language, install guidance, no performance numbers, and
no unexplained engineering jargon.
Verification
/Users/nicolaslazaro/Desktop/work/shed/crates/python/.venv/bin/mkdocs build --strict -f mkdocs.yml -d .mkdocs-site-check && rm -rf .mkdocs-site-check: passed.! grep -n '—' docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md: passed.! grep -nwiE 'minute|minutes|second|seconds|millisecond|milliseconds|ms' docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md: passed.! cat docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md | tr -s '[:space:]' ' ' | grep -oiE 'row.group|range.read|object.store|rayon|pyo3|projjson|hilbert|xdg|arrow|HDX': passed.! cat docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md | tr -s '[:space:]' ' ' | grep -oiE "does not delineate|does not extend or improve|not a license obligation|n't just|it's not|isn't": passed.! grep -qi 'hybrid' docs/index.md && ! cat docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md | tr -s '[:space:]' ' ' | grep -oiE 'drainage.basin': passed.! cat docs/index.md docs/quickstart.md docs/guide/datasets.md docs/credits.md | tr -s '[:space:]' ' ' | grep -oiE 'TerminalRefinementStrategy|bring.your.own|carve': passed.tr -s '[:space:]' ' ' < docs/index.md | grep -q 'uv add pyshed' && tr -s '[:space:]' ' ' < docs/index.md | grep -q 'pip install pyshed' && tr -s '[:space:]' ' ' < docs/quickstart.md | grep -q 'uv add pyshed' && tr -s '[:space:]' ' ' < docs/quickstart.md | grep -q 'pip install pyshed': passed.tr -s '[:space:]' ' ' < docs/index.md | grep -qF 'whole upstream area that drains to it, the watershed' && tr -s '[:space:]' ' ' < docs/index.md | grep -qF 'folder of pre-built river-network files' && tr -s '[:space:]' ' ' < docs/guide/datasets.md | grep -qF 'folder of pre-built river-network files' && tr -s '[:space:]' ' ' < docs/quickstart.md | grep -qF 'reuse data already fetched, so overlapping watersheds are faster' && grep -qi 'connections' docs/quickstart.md: passed.grep -qi 'slower' docs/quickstart.md && grep -qi 'reuse' docs/quickstart.md && grep -qi 'slower' docs/guide/datasets.md && grep -qi 'reuse' docs/guide/datasets.md: passed.grep -q 'Heberger' docs/credits.md && grep -q '0000-0001-9122-0030' docs/credits.md && grep -q 'github.com/mheberger/delineator' docs/credits.md && grep -q 'doi.org/10.2139/ssrn.5939056' docs/credits.md && grep -q '@software{delineator' docs/credits.md && grep -q 'Djokic' docs/credits.md && grep -q 'mghydro.com/watersheds' docs/credits.md: passed.tr -s '[:space:]' ' ' < docs/guide/datasets.md | grep -qF 'Upstream Tech' && grep -q 'flow_dir.tif' docs/guide/datasets.md && tr -s '[:space:]' ' ' < docs/guide/datasets.md | grep -qi 'no D8 raster': passed.git show --name-only --format= HEAD | sort: passed with exactlydocs/credits.md,docs/guide/datasets.md,docs/index.md, anddocs/quickstart.md.