From affa366bf869568ff79ba3b08e3154459427184f Mon Sep 17 00:00:00 2001 From: stacknil Date: Sat, 6 Jun 2026 01:46:49 +0800 Subject: [PATCH] docs(review): align package metadata framing --- docs/reviewer-pack.md | 1 + pyproject.toml | 3 +-- tests/test_reviewer_docs.py | 18 ++++++++++++++++++ 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/reviewer-pack.md b/docs/reviewer-pack.md index 7fe94cf..3905551 100644 --- a/docs/reviewer-pack.md +++ b/docs/reviewer-pack.md @@ -53,6 +53,7 @@ Before treating the repo as v1-style consolidated: - Keep the four-demo matrix stable, or document any intentional retirement in the README, reviewer path, reviewer pack, roadmap, and tests. - Keep reviewer-visible artifact names stable, or update the artifact naming contract and committed sample outputs in the same change. - Keep `docs/reviewer-path.md`, this reviewer pack, `docs/architecture.md`, and demo READMEs aligned with actual CLI behavior. +- Keep README, package metadata, and repository metadata aligned with the local, file-based detection workflow lab framing. - Regenerate and inspect committed artifacts after behavior changes. - Run `pytest` and confirm reviewer-doc tests still cover the demo matrix, artifact contract, and architecture boundaries. - Do not add SIEM, dashboard, alert routing, case-management, real-time ingestion, autonomous response, or final-verdict claims. diff --git a/pyproject.toml b/pyproject.toml index 5fc5919..023064f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "telemetry-window-demo" version = "0.1.0" -description = "A small prototype for windowed telemetry analytics on timestamped event streams." +description = "A local, file-based detection workflow lab for reviewer-verifiable telemetry and detection demos." readme = "README.md" license = { file = "LICENSE" } requires-python = ">=3.11" @@ -27,4 +27,3 @@ where = ["src"] [tool.pytest.ini_options] pythonpath = ["src"] testpaths = ["tests"] - diff --git a/tests/test_reviewer_docs.py b/tests/test_reviewer_docs.py index f9157d6..1d2db25 100644 --- a/tests/test_reviewer_docs.py +++ b/tests/test_reviewer_docs.py @@ -1,5 +1,6 @@ from __future__ import annotations +import tomllib from pathlib import Path @@ -76,6 +77,10 @@ def _read_repo_file(relative_path: str) -> str: return (REPO_ROOT / relative_path).read_text(encoding="utf-8") +def _read_pyproject() -> dict[str, object]: + return tomllib.loads(_read_repo_file("pyproject.toml")) + + def test_reviewer_path_keeps_detection_lab_positioning() -> None: reviewer_path = _read_repo_file("docs/reviewer-path.md") normalized = reviewer_path.lower() @@ -107,6 +112,18 @@ def test_readme_links_reviewer_path_and_uses_lab_framing() -> None: assert "[`docs/architecture.md`](docs/architecture.md)" in readme +def test_package_metadata_uses_detection_lab_framing() -> None: + pyproject = _read_pyproject() + description = str(pyproject["project"]["description"]) + + assert description == ( + "A local, file-based detection workflow lab for " + "reviewer-verifiable telemetry and detection demos." + ) + assert "small prototype" not in description.lower() + assert "monitoring platform" not in description.lower() + + def test_top_level_reviewer_pack_covers_matrix_and_artifact_contract() -> None: reviewer_pack = _read_repo_file("docs/reviewer-pack.md") @@ -139,6 +156,7 @@ def test_reviewer_pack_defines_v1_readiness_gate() -> None: assert "## v1 Readiness Gate" in reviewer_pack assert "four-demo matrix stable" in reviewer_pack assert "reviewer-visible artifact names stable" in reviewer_pack + assert "package metadata, and repository metadata" in reviewer_pack assert "Regenerate and inspect committed artifacts" in reviewer_pack assert "Run `pytest`" in reviewer_pack assert "Do not add SIEM, dashboard, alert routing" in reviewer_pack