Skip to content

Add reviewer start section #54

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.

Sign up for GitHub

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
stacknil merged 1 commit into from
Jun 12, 2026
Merged

Add reviewer start section #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ A local, file-based detection workflow lab for reviewer-verifiable telemetry and

Latest milestone: [v0.6.0 — fourth demo and config-change investigation](https://github.com/stacknil/telemetry-lab/releases/latest).

## Reviewer Start

- [`docs/reviewer-brief.md`](docs/reviewer-brief.md): scope, value, evidence, and boundaries
- [`docs/reviewer-path.md`](docs/reviewer-path.md): choose the right demo by review question
- [`docs/reviewer-pack.md`](docs/reviewer-pack.md): demo matrix, artifact contract, and v1 readiness gate
- [`docs/README.md`](docs/README.md): current route, supporting docs, and historical release evidence

## Demos

- [telemetry-window-demo](#telemetry-window-demo)
Expand Down
5 changes: 5 additions & 0 deletions tests/test_reviewer_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ def test_readme_links_reviewer_path_and_uses_lab_framing() -> None:
assert "A local, file-based detection workflow lab" in readme
assert "local, reviewer-oriented detection workflow lab" in readme
assert "not a SIEM, dashboard, or monitoring platform" in readme
assert "## Reviewer Start" in readme
assert "scope, value, evidence, and boundaries" in readme
assert "choose the right demo by review question" in readme
assert "demo matrix, artifact contract, and v1 readiness gate" in readme
assert "current route, supporting docs, and historical release evidence" in readme
assert "[`docs/README.md`](docs/README.md)" in readme
assert "[`docs/reviewer-pack.md`](docs/reviewer-pack.md)" in readme
assert "[`docs/reviewer-brief.md`](docs/reviewer-brief.md)" in readme
Expand Down
Loading