-
Notifications
You must be signed in to change notification settings - Fork 0
[codex] sync v0.4.0 release docs #19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # v0.4.0 — second demo and portfolio integration | ||
|
|
||
| This is a small portfolio milestone release for `telemetry-lab`. | ||
|
|
||
| The repository now presents a two-demo structure: | ||
|
|
||
| | Demo | Role | | ||
| | --- | --- | | ||
| | `telemetry-window-demo` | Windowed telemetry analysis with deterministic rules, CSV outputs, and timeline artifacts | | ||
| | `ai-assisted-detection-demo` | Deterministic detection and case grouping with constrained LLM summarization and auditable rejection paths | | ||
|
|
||
| ## What changed | ||
|
|
||
| ### Repo structure and front door | ||
|
|
||
| - The landing page now presents `telemetry-lab` as a two-demo repository | ||
| - The top-level README includes direct navigation to both demos | ||
| - The public repo story is now easier to scan from the landing page | ||
|
|
||
| ### New second demo | ||
|
|
||
| - Added `ai-assisted-detection-demo` | ||
| - The demo centers on: | ||
| - deterministic detection | ||
| - deterministic case grouping | ||
| - constrained LLM summarization | ||
| - audit traces and visible rejection paths | ||
|
|
||
| ### Guardrails and boundaries | ||
|
|
||
| - `human_verification` is required | ||
| - No autonomous response actions | ||
| - No final incident verdict | ||
| - No LLM-driven detection or grouping decisions | ||
| - Fail-closed validation remains in place for invalid or disallowed outputs | ||
|
|
||
| ### Reviewer-facing documentation | ||
|
|
||
| - Added a walkthrough for: | ||
| - accepted summary path | ||
| - rejected summary path | ||
| - degraded coverage path | ||
| - Added an explicit lifecycle contract and audit schema version in the design documentation | ||
|
|
||
| ## Why this milestone matters | ||
|
|
||
| This release moves `telemetry-lab` from a single-demo prototype toward a clearer portfolio repository with: | ||
|
|
||
| - one telemetry/windowing workflow | ||
| - one case-centric, AI-assisted investigation workflow | ||
| - explicit guardrails around model output and operator review | ||
|
|
||
| ## Validation | ||
|
|
||
| - Full test suite: `43 passed` | ||
|
|
||
| ## Notes | ||
|
|
||
| This is a portfolio milestone release, not a product launch. | ||
| The repository remains intentionally scoped to small, reviewable prototypes. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use an immutable tag URL here instead of
/releases/latest. The text and adjacent local note are explicitly versioned tov0.4.0, but/latestwill redirect to whatever the newest release is; after the next release this line will send readers to a different version while still labeling it asv0.4.0, creating a README/docs mismatch.Useful? React with 👍 / 👎.