docs(site): write user documentation content#18
Merged
CooperBigFoot merged 1 commit intoJul 3, 2026
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.
User documentation content: Home, Quickstart, guides, API Reference, triage (m4)
Fills the placeholder pages m3 created with real user-facing prose and triages two
existing docs. Content-only —
mkdocs.ymland the mkdocstrings directive configare untouched (m3-owned);
how-it-works.mdandcredits.mdare untouched(m5-owned).
What's here
docs/index.md— Home/overview: what shed/pyshed is, who it's for, installone-liner, links into the nav.
docs/quickstart.md— install → open anEngineagainst the hosted GRITHFX dataset (zero-download) → delineate a
(lat, lon)→ readarea_km2andto_geojson(), in one copy-pasteable script; outlet / delineation / HFX-datasetglossed.
docs/guide/datasets.md— the HFX artifacts (manifest.json,catchments.parquet,graph.parquet, optionalsnap.parquet+ D8 rasters),the canonical hosted GRIT dataset (URL + Upstream Tech hosting attribution), and
local vs. remote opening.
docs/guide/staged-api.md— the staged pipelineselect_level → resolve_outlet → traverse → pre_merge_units → refine → dissolve → compose_result, the typed object each stage returns, and staged vs. one-shotguidance.
docs/api-reference.md— new intro prose around m3's unchanged::: pysheddirective.
docs/basin-geoparquet-export.md— reframes the internal "Status" /"Elevation Path" framing for a public audience; schema and technical body
preserved; not elevated into a versioned spec.
docs/raster-cache.md— trimmed toward the user-relevantrefine=Falsecaveat.
Verification
uv run --project crates/python --only-group docs mkdocs build --strictsucceeds with zero warnings and no cargo/maturin/GDAL activity (no
target/).EngineandDelineationResult.__init__.pyisignatures.Expected CI behavior (not a regression)
docs/, so it does not trigger thecibuildwheel/GDAL wheel build (that path filters on
crates/python/**, notdocs/**).docs.ymlruns on push-main, not on PRs; itsdeployjob stayshuman-gated on Pages enablement.