Skip to content

Commit 3a2554a

Browse files
johnmathewsclaude
andcommitted
Document demo_samples/ in CLAUDE.md and architecture.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3f2d867 commit 3a2554a

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ loan documents.
2929
- `src/gateway/` — FastAPI API + web UI (processes documents synchronously for now)
3030
- `src/worker/` — Extract, classify, and semantic classification modules
3131
- `src/generator/` — PDF document generator (5 templates, CLI tool)
32+
- `demo_samples/` — One complete loan scenario (5 PDFs, committed to git for visibility)
3233
- `tests/` — All tests (51 tests)
3334
- `k8s/` — Kubernetes manifests (empty — Day 2)
3435
- `infra/` — Azure setup/teardown scripts (empty — Day 2)
@@ -40,7 +41,8 @@ loan documents.
4041
## Commands
4142
- `make test` — Run tests with pytest
4243
- `make lint` — Run ruff linter
43-
- `make generate` — Generate sample documents
44+
- `make generate` — Generate 10 scenarios (50 PDFs) in `generated_docs/` (gitignored)
45+
- `make demo-samples` — Regenerate `demo_samples/` with one fresh loan scenario (committed to git)
4446
- `make dev` — Start local dev environment (docker-compose)
4547

4648
## Key Patterns

docs/architecture.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,11 @@ LoanScenario
242242
| Loan agreement | Secret | High (~1100 words) | Yes |
243243
| Contractor invoice | Public | Low (~100 words) | No |
244244

245+
Sample PDFs for all 5 types are committed in `demo_samples/` so the generated
246+
content is visible without running the generator. Regenerate with `make demo-samples`.
247+
Bulk generation for stress testing uses `make generate` (outputs to `generated_docs/`,
248+
gitignored).
249+
245250
---
246251

247252
## Key Design Decisions

0 commit comments

Comments
 (0)