diff --git a/.gitignore b/.gitignore index 7b5e68e..dd87ca6 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ report/ deploy/*.env # private TLS keys and certificates deploy/tls/ -# design/planning documents kept locally, not tracked -docs/SPECIFICATION.md -docs/implementation/ +# design, planning, handoff, review and report documents kept locally, not tracked +docs/ +**/HANDOFF.md +agent/REVIEW.md diff --git a/README.md b/README.md index 5cada85..defbf08 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,8 @@ A minimalist web UI that researches a Confluence Data Center instance with a [pi](https://github.com/earendil-works/pi) agent running in a fresh, network-less rootless Docker container per query, and returns a cited Markdown answer plus -optional files the agent produced. The integration results are in -[docs/INTEGRATION_REPORT.md](docs/INTEGRATION_REPORT.md); each component -documents its own interface in `agent/README.md`, `backend/README.md` and -`frontend/README.md`. +optional files the agent produced. Each component documents its own interface +in `agent/README.md`, `backend/README.md` and `frontend/README.md`. The repository also contains the original standalone [Confluence crawler](#standalone-crawler), which is unchanged. diff --git a/agent/README.md b/agent/README.md index 635356b..112fb7c 100644 --- a/agent/README.md +++ b/agent/README.md @@ -69,8 +69,6 @@ aggregate limits produce bounded warnings, and a traversal budget prevents unbounded directory enumeration. The backend still receives untrusted bytes and must independently validate paths, sizes, storage and attachment delivery. -See [HANDOFF.md](HANDOFF.md) for evidence, exact pins and outstanding integration -checks, and [REVIEW.md](REVIEW.md) for problems corrected in the initial code. Completion is committed only after the complete frame finishes writing. The bridge timer is then cleared and no further terminal error is emitted; the supervisor's diff --git a/backend/README.md b/backend/README.md index 726de45..e862af4 100644 --- a/backend/README.md +++ b/backend/README.md @@ -20,7 +20,6 @@ backend/ fake_entrypoint.py # Container entrypoint for fake peer Dockerfile.fake # Test container image definition README.md # Configuration & documentation - HANDOFF.md # Integration handoff details ``` ## Environment Variables diff --git a/frontend/README.md b/frontend/README.md index 61e179b..b2bd569 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -31,8 +31,7 @@ frontend/ ├── package.json ├── package-lock.json ├── .gitignore -├── README.md -└── HANDOFF.md +└── README.md ``` ## Security & Architecture Highlights diff --git a/tests/backend/test_review_regressions.py b/tests/backend/test_review_regressions.py index 15bb74f..301ee8b 100644 --- a/tests/backend/test_review_regressions.py +++ b/tests/backend/test_review_regressions.py @@ -1,4 +1,4 @@ -"""Failure and byte-boundary regressions from BACKEND_REVIEW.md.""" +"""Failure and byte-boundary regressions found in the backend review.""" import asyncio import base64 import json