Skip to content

docs(phase0): document extraction guardrails and flow #12

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
mikeylong merged 1 commit into from
Mar 14, 2026
Merged

docs(phase0): document extraction guardrails and flow #12

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
9 changes: 9 additions & 0 deletions docs/plans/phase-0-extraction-guardrails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

**Scope:** Contract extraction from Next.js app code (`interfacectl generate-contract`). Phase-scoped and revisitable.

## How extraction works

- **Input:** Next.js app directory (contains `app/`).
- **Method:** Filesystem walk + regex. No JSX, TypeScript, or CSS parsing.
- **Output:**
- `contracts/generated/<surface>.contract.json` — schema-valid contract with extracted facts under `x_extracted`.
- `contracts/generated/<surface>.extraction.json` — machine-readable extraction report and warnings.
- **Validation:** `validate-extracted` compares policy expectations (`surfaces[].phase0` in the policy contract) to extracted reality and fails CI on mismatch.

---

## No heavy AST in Phase 0
Expand Down