Skip to content

[codex] sync v0.4.0 release docs#19

Merged
stacknil merged 1 commit into
mainfrom
codex/release-v0.4.0-docs
Mar 31, 2026
Merged

[codex] sync v0.4.0 release docs#19
stacknil merged 1 commit into
mainfrom
codex/release-v0.4.0-docs

Conversation

@stacknil
Copy link
Copy Markdown
Owner

Summary

This PR is a very small documentation-only sync to reduce drift between the published v0.4.0 GitHub 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.0 was published, the GitHub Release accurately described telemetry-lab as a two-demo portfolio repository with the new ai-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.md and docs/release-v0.4.0.md were not included in the tag.

Fix

This PR updates two files only:

  • README.md now includes a short Latest milestone entry near the top that links to the stable latest-release URL and points readers to the local release note.
  • docs/release-v0.4.0.md is added to the docs tree and mirrors the published v0.4.0 release framing: a two-demo telemetry-lab, deterministic detection and grouping plus constrained LLM summarization, required human_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 passed

Changed files

  • README.md
  • docs/release-v0.4.0.md

@stacknil stacknil marked this pull request as ready for review March 31, 2026 08:31
@stacknil stacknil merged commit 8c4dc70 into main Mar 31, 2026
2 checks passed
@stacknil stacknil deleted the codex/release-v0.4.0-docs branch March 31, 2026 08:32
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread README.md

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).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant