[codex] sync v0.4.0 release docs#19
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b12af7bd4c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Small portfolio prototypes for telemetry analytics, monitoring, and detection-oriented signal processing. | ||
|
|
||
| Latest milestone: [v0.4.0 — second demo and portfolio integration](https://github.com/stacknil/telemetry-lab/releases/latest). See [release notes](docs/release-v0.4.0.md). |
There was a problem hiding this comment.
Point milestone link to fixed v0.4.0 release URL
Use an immutable tag URL here instead of /releases/latest. The text and adjacent local note are explicitly versioned to v0.4.0, but /latest will redirect to whatever the newest release is; after the next release this line will send readers to a different version while still labeling it as v0.4.0, creating a README/docs mismatch.
Useful? React with 👍 / 👎.
Summary
This PR is a very small documentation-only sync to reduce drift between the published
v0.4.0GitHub Release and the repository's visible docs.The release already exists publicly, but the local README and release helper doc changes were not part of the published tag. This PR brings the repo front door into line with that public release story without changing any runtime behavior.
Problem
After
v0.4.0was published, the GitHub Release accurately describedtelemetry-labas a two-demo portfolio repository with the newai-assisted-detection-demo, constrained LLM summarization, and explicit operator-review boundaries.Those same release-facing details were not yet reflected in the checked-in repo docs. That left a small but visible gap between what a reviewer saw on the Releases page and what they saw when landing in the repository.
Root cause
The release itself was created from the already-published GitHub release notes, while the local documentation updates to
README.mdanddocs/release-v0.4.0.mdwere not included in the tag.Fix
This PR updates two files only:
README.mdnow includes a shortLatest milestoneentry near the top that links to the stable latest-release URL and points readers to the local release note.docs/release-v0.4.0.mdis added to the docs tree and mirrors the publishedv0.4.0release framing: a two-demotelemetry-lab, deterministic detection and grouping plus constrained LLM summarization, requiredhuman_verification, no autonomous response, and no final incident verdict.No code paths, CLI behavior, validation logic, or guardrail semantics are changed.
Validation
python -m pytest->43 passedChanged files
README.mddocs/release-v0.4.0.md