Skip to content

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

Merged
mikeylong merged 1 commit into
mainfrom
docs/phase0-extraction-guardrails
Mar 14, 2026
Merged

mikeylong merged 1 commit into
mainfrom
docs/phase0-extraction-guardrails

Conversation

@mikeylong

Copy link
Copy Markdown
Collaborator

What changed

  • docs/plans/phase-0-extraction-guardrails.md — Added structured "How extraction works" section

Why

Ownership split: interfacectl owns tool semantics and limits. This doc explains:

  • Input: Next.js app directory
  • Method: filesystem walk + regex (no AST)
  • Output: contracts/generated/<surface>.contract.json (x_extracted) and <surface>.extraction.json
  • validate-extracted compares policy expectations to extracted reality

No duplicate dogfooding/policy content in interfacectl.

Verification

  • docs/plans/phase-0-extraction-guardrails.md exists
  • API.md references guardrails doc (generate-contract section)
  • Link: docs/plans/phase-0-extraction-guardrails.md

Made with Cursor

- Add structured 'How extraction works' section: input, method, output paths, validation
- Clarify filesystem + regex extraction, no AST
- Output: contracts/generated/<surface>.contract.json and .extraction.json
- validate-extracted compares policy to extracted reality

Co-authored-by: Cursor <cursoragent@cursor.com>
@mikeylong
mikeylong merged commit e4f4a4e into main Mar 14, 2026
2 checks passed
@mikeylong
mikeylong deleted the docs/phase0-extraction-guardrails branch March 14, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant