docs(release): reconcile README, SPEC, roadmap, and release notes for v0.3.0 - #43
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.
Summary
Reconcile the repository documentation with the delivered
v0.3.0ingestion baseline.The runtime is no longer a catalog/bootstrap-only foundation:
fetchis implemented, ingestion observations are persisted in SQLite, and GitHub/news/changelog source support is real. This PR updates the docs so they describe the implemented runtime rather than the earlier pre-implementation contract freeze.Linked issue(s)
Milestone fit
This PR completes the documentation/release alignment portion of the
v0.3.0milestone.It keeps the repository honest about what is already delivered:
fetchCLI executionfetch_runs,metric_snapshots, andcontent_itemsIt also keeps the milestone boundary explicit by documenting that scheduler, alerts, API, and dashboard work remain deferred.
What changed
README.mdwith a reviewer-usable fetch quickstartSPEC.md,docs/architecture.md,docs/configuration.md,docs/data-model.md, anddocs/reference-dataset.mdwith the implemented ingestion runtimedocs/roadmap.md,CHANGELOG.md, and drafteddocs/releases/v0.3.0.mdGITHUB_TOKENbehaviorOut of scope
github.contributorsaggregationValidation
Mark what you actually ran:
python3 ./scripts/trim-whitespace.py --checkgo vet ./...go test ./...make ciManual verification performed:
Manual verification notes:
news_rsssucceeded and populatedfetch_runs,metric_snapshots, andcontent_itemsfetch_runsDocumentation impact
README.mdSPEC.mddocs/AGENTS.md,CONTRIBUTING.md)CHANGELOG.mdReviewer focus
Please review the docs against the actual runtime behavior in particular for:
README.mdfetchsemantics, especially reseed-before-fetch behaviorGITHUB_TOKENpathAuditability checklist
Notes for merge
Preferred merge method: