docs(site): rewrite how-it-works on precomputed catchment connections#22
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): rewrite how-it-works on precomputed catchment connections
What changed
Rewrote
docs/how-it-works.mdaround precomputed hydrofabric catchment connections.Removed the raster/vector/D8 teaching narrative and replaced it with the point-to-watershed lookup, upstream traversal, and merge flow.
Kept the Heberger credit and
credits.mdlink, with refinement reduced to one closing sentence.Why
The page now matches the intended audience and framing: hydrology users need to understand that
shedstarts from a hydrofabric whose unit catchments and upstream connections are already computed.The explanation keeps D8 details out of the main narrative while preserving the optional outlet-trim constraint for datasets that ship the raster.
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! grep -q '—' docs/how-it-works.md! grep -qiE 'HDX|TerminalRefinementStrategy|row group|range read|rayon|pyo3|projjson|hilbert|xdg|object.store' docs/how-it-works.md && ! grep -qE '\bArrow\b' docs/how-it-works.md! grep -qiE "isn['’]t|it['’]s not|it is not|not just|not original|rather than" docs/how-it-works.md! grep -qiE '[0-9]+ ?(ms\b|millisecond|second|minute)' docs/how-it-works.md! grep -qiE 'Two classic ways|flow accumulation|eight directions' docs/how-it-works.mdhead -n 6 docs/how-it-works.md | grep -qi 'watershed' && ! grep -qi 'drainage basin' docs/how-it-works.mdgrep -q 'Heberger' docs/how-it-works.md && grep -q 'credits.md' docs/how-it-works.md && grep -qF 'the whole upstream area that drains to it, the watershed' docs/how-it-works.md && grep -qF 'pre-built river-network files' docs/how-it-works.mdtest "$(grep -ci 'refin' docs/how-it-works.md)" -le 1test "$(git diff --name-only)" = "docs/how-it-works.md"test "$(git show --name-only --format= HEAD | tr -d '\n')" = "docs/how-it-works.md"