diff --git a/README.md b/README.md index 29d26fd..3205416 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,7 @@ Cooldown behavior: - [`demos/rule-evaluation-and-dedup-demo/README.md`](demos/rule-evaluation-and-dedup-demo/README.md) explains the third demo and links its committed before/after dedup artifacts - [`demos/config-change-investigation-demo/README.md`](demos/config-change-investigation-demo/README.md) explains the config-change investigation demo and its committed artifacts - [`docs/reviewer-pack.md`](docs/reviewer-pack.md) is the top-level no-guessing reviewer pack and artifact naming contract +- [`docs/reviewer-brief.md`](docs/reviewer-brief.md) gives the short problem, value, evidence, and boundary summary - [`docs/reviewer-path.md`](docs/reviewer-path.md) maps common review questions to the right demo and artifacts - [`docs/architecture.md`](docs/architecture.md) diagrams the local file-based detection workflow - [`docs/sample-output.md`](docs/sample-output.md) summarizes the committed sample artifacts diff --git a/tests/test_reviewer_docs.py b/tests/test_reviewer_docs.py index 8a6ae4c..e6a7944 100644 --- a/tests/test_reviewer_docs.py +++ b/tests/test_reviewer_docs.py @@ -112,6 +112,7 @@ def test_readme_links_reviewer_path_and_uses_lab_framing() -> None: assert "local, reviewer-oriented detection workflow lab" in readme assert "not a SIEM, dashboard, or monitoring platform" in readme assert "[`docs/reviewer-pack.md`](docs/reviewer-pack.md)" in readme + assert "[`docs/reviewer-brief.md`](docs/reviewer-brief.md)" in readme assert "[`docs/reviewer-path.md`](docs/reviewer-path.md)" in readme assert "[`docs/architecture.md`](docs/architecture.md)" in readme assert "portfolio prototype" not in normalized