docs(readme): S3 — rewrite the README to current reality (#73)#80
Merged
Conversation
The README described the deleted runtime spatial mapper as the repo's core: PriogridCountryMapper, shapefiles, geopandas, disk/memory caching, cachetools — all removed (ADR-011 / C-39). It also carried a wrong PROD_FORECASTS_COLLECTION_ID, a dead link to a deleted mapping/README, an incomplete 7-column output schema, and a stale dependency table. Rewritten to current reality: a post-forecast delivery layer (a pipeline-core postprocessor) that GAUL-enriches via lookup-join and enforces input-integrity guards. Correct dependency table (drops cachetools), real package structure, the full 9-column schema, the env-var collection-ID flagged as needs-verify, pipeline stages incl. validate/coverage/clip, and a prominent pointer to the S2 orientation doc. No deleted-symbol references; all relative links resolve. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Epic: #70 · S3 (#73) · depends on #71 ✅, #72 ✅
Rewrites the README, which still sold the repo as a runtime spatial-mapping library (
PriogridCountryMapper, shapefiles, geopandas, caching,cachetools— all deleted in ADR-011 / C-39), with a wrongPROD_FORECASTS_COLLECTION_ID, a deadmapping/READMElink, and a stale dependency table + incomplete schema.Now: a post-forecast delivery layer (a pipeline-core postprocessor) that GAUL-enriches by lookup-join + enforces input-integrity guards. Verified: correct dependency table (drops
cachetools), real package structure, full 9-column schema, env-var collection-ID flagged as needs-verify, stages incl. validate/coverage/clip, prominent pointer to the orientation doc. No deleted-symbol references; all relative links resolve.Docs-only; ruff clean, suite green.
Closes #73
🤖 Generated with Claude Code