How abdi219/parity works
Parity is a static API-documentation drift auditor. A user selects the demo or a public repository; the audit endpoint discovers or reads files, extracts documented and implemented contracts, compares them deterministically, and returns findings with provenance. The UI can apply suggested documentation patches and submit the patched text for a closed-loop re-audit. The route handler owns orchestration; the available excerpts do not show every call site, so documented workflow links use README evidence where needed.
Main entry points: route.ts Audit endpoint · page.tsx Audit UI · driftEngine.ts Provenanced findings · docExtractor.ts Documentation extraction
Components 17
Audit interface
- Audit UI
web/src/app/page.tsx - Findings and map
web/src/app/page.tsx
Audit orchestration
- Audit endpoint
web/src/app/api/audit/route.ts - Demo source endpoint
web/src/app/api/audit-source/route.ts - Repository discovery
web/src/app/api/audit/route.ts - Selected file fetch
web/src/app/api/audit/route.ts - Demo API documentation
dummy-auth-service/README.md - Demo auth handlers
dummy-auth-service/src/auth.ts
Contract extraction
- Documentation extraction
web/src/lib/docExtractor.ts - Source extraction
web/src/lib/codeExtractor.ts - Normalized contracts
web/src/types/contract.ts
Comparison and repair
- Deterministic drift engine
web/src/lib/driftEngine.ts - Provenanced findings
web/src/lib/driftEngine.ts - Patch and diff engine
web/src/lib/patchEngine.ts
Other components
- Engineer
- GitHub
- Groq fallback
Connections 23
- Engineer → Audit UI: starts audit
README.md - Audit UI → Audit endpoint: submits audit
README.md - Audit UI → Demo source endpoint: loads demo docs
web/src/app/page.tsx - Demo source endpoint → Demo API documentation: reads demo docs
web/src/app/api/audit-source/route.ts - Audit endpoint → Repository discovery: discovers files
web/src/app/api/audit/route.ts - Repository discovery → GitHub: requests tree
web/src/app/api/audit/route.ts - Audit endpoint → Selected file fetch: fetches selected files
web/src/app/api/audit/route.ts - Selected file fetch → GitHub: fetches file content
web/src/app/api/audit/route.ts - Audit endpoint → Documentation extraction: extracts documentation
web/src/app/api/audit/route.ts - Audit endpoint → Source extraction: extracts implementation
web/src/app/api/audit/route.ts - Documentation extraction → Groq fallback: uses prose fallback
web/src/lib/docExtractor.ts - Source extraction → Groq fallback: uses targeted fallback
web/src/lib/codeExtractor.ts - Documentation extraction → Normalized contracts: produces contracts
web/src/types/contract.ts - Source extraction → Normalized contracts: produces contracts
web/src/types/contract.ts - Audit endpoint → Deterministic drift engine: compares contracts
README.md - Deterministic drift engine → Provenanced findings: reports drift
web/src/lib/driftEngine.ts - Audit endpoint → Provenanced findings: returns audit report
README.md - Provenanced findings → Findings and map: displays evidence
README.md - Findings and map → Audit UI: renders in
web/src/app/page.tsx - Audit UI → Patch and diff engine: applies patches
web/src/app/page.tsx - Audit UI → Audit endpoint: submits re-audit
web/src/app/page.tsx - Demo auth handlers → Provenanced findings: supplies implementation evidence
README.md - Demo API documentation → Provenanced findings: supplies documentation evidence
README.md