Skip to content

docs(architecture): establish canonical PRD TRD and UML contract - #361

Draft
seonghobae wants to merge 8 commits into
mainfrom
codex/docs-prd-trd-uml-contract-20260912
Draft

docs(architecture): establish canonical PRD TRD and UML contract#361
seonghobae wants to merge 8 commits into
mainfrom
codex/docs-prd-trd-uml-contract-20260912

Conversation

@seonghobae

@seonghobae seonghobae commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Finding

Protected main@f8260f1e03836039ff9463dd99fa982e4e270c4b has code-current architecture/specification material and ADRs, but no canonical PRD, TRD, or UML artifact. That leaves product scope, technical acceptance, and owner boundaries distributed across prose and makes documentation drift hard to detect mechanically.

This lane is intentionally disjoint from #130 (docs/product-technical-gap-baseline.md) and #111 (accepted ADR consolidation). It does not edit either owner path and does not change runtime behavior.

Hostile RED

Exact structural RED 01d6640304eab7913d508b342243e222fda1c689 added tests/documentation_contract.rs. It references the canonical PRD/TRD/UML paths and explicit owner-boundary/performance/release markers. That first head advanced before its hosted run completed, so it is not claimed as hosted failure evidence.

The first hosted documentation-contract RED was observed on exact head a533001a8d42fe90ec2310143b71c5cea191e3e6: repository Rust CI reached the new documentation test after 142 core tests passed and failed on the case-sensitive PRD authority marker. Minimum causal repair 5334a6039d368d59f455c5040f03e5dbc5c7d8fe aligned that marker with the canonical heading without weakening the contract.

A second buyer-facing contract defect was then reproduced on exact head 5668ba29dd7ee1b4488c601597bfc49c4944dabb. The Material UI requirement allowed design-system or Storybook/Figma evidence only "where applicable" and the TRD did not mechanically bind Figma/Storybook evidence. CI 34690078651, job 103543672297, reached the new documentation contract after all 142 core tests passed and failed exactly at material_ui_and_slow_work_boundaries_remain_explicit: PRD must retain the code-current marker "Figma/Storybook evidence".

The minimum causal repair was split into ordinary fast-forward commits because the contents API writes one file at a time: bec85782c8e17865beec2267b0c406e5d16649c9 makes PRD Figma/Storybook evidence mandatory, and c6d3fd45eba1aceef074cc8b9934937f67b1d41a binds the same requirement in the TRD. The hostile test itself remains intact.

GREEN acceptance

Add the minimum code-current canonical artifacts without duplicating foreign-owner implementation logic:

  • PRD: Wardnet buyer/product outcomes and ownership boundaries for gateway/SOC control plane, Agent Artifact Admission, security evidence/policy;
  • TRD: Rust-first technical constraints, released-contract-only dependencies, credential/runtime configuration boundaries, p95 <= 20 ms buyer path target, SBOM/provenance/release acceptance;
  • UML: component/dependency view that represents quarantine-sandbox-runtime, EgressWeave, contextual-orchestrator and appguardrail only as external canonical owners/contracts;
  • Material UI requirements: reusable design/tokens/components, mandatory Figma/Storybook evidence, normal/loading/empty/error/permission/responsive/keyboard/a11y acceptance, and KO/EN/JA/ZH/VI/ES/DE/FR text-layout robustness;
  • slow-work database boundary: no explicit database lock or long-lived transaction may span LLM calls, external I/O, sandbox execution, or long-running computation.

The artifacts must trace protected-main truth and authoritative standards, remain compatible with existing ADR/architecture/security/ops/release documentation, and make tests/documentation_contract.rs GREEN on one unchanged exact head.

Exact-head evidence

Current exact head: c6d3fd45eba1aceef074cc8b9934937f67b1d41a.

  • CI 34690323747: SUCCESS on the unchanged exact head; rust job 103544312321 passed format, locked workspace tests including the hostile documentation contract, and strict Clippy.
  • Security Scan 34690323751: SUCCESS on the unchanged exact head.
  • SAST Semgrep 34690323719: SUCCESS on the unchanged exact head.
  • CodeQL PR 34690323728: FAILURE only at central delegated terminal settlement. Detect job 103545057667 checked out the exact head and succeeded; compatibility job 103545768079 successfully read the current-head verdict and failed at Release runner or enforce current-head CodeQL verdict; downstream dispatch job 103547018215 then succeeded. Fresh consumer evidence and unchanged-head RED/GREEN acceptance are handed to canonical owner .github#1929; no Wardnet workflow copy, source churn, synthetic status, or bypass is authorized.
  • Review submissions: none at the latest read.
  • Review threads: none at the latest read.

Foreign-owner revalidation confirms context-graph-contracts protected develop@99cb5468ba3c15c5e79688f53dee74724fae2d13 and enterprise-architecture-core protected develop@dd71e40a86385fb7861b0f1be19891a3f3e29ece still have no immutable GitHub Release; both remain read-only to this lane. contextual-orchestrator protected main@012beaacd0631f8cd3391c77744eeb626269b5de includes its typed versioned admission work but still has no immutable GitHub Release, so Wardnet does not add a mutable CO dependency. EgressWeave, quarantine-sandbox-runtime, and appguardrail also have no immutable GitHub Release, so their canonical logic remains foreign and is not copied into Wardnet.

Keep Draft until exact-head required checks/review/thread evidence is terminal and current. No force push, self/model approval, routine bypass, source-copy, cross-service SQL, mutable foreign dependency, or edits to CGC/EA.

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-prd-trd-uml-contract-20260912

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Head commit changed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@seonghobae seonghobae added documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work labels Sep 12, 2026 — with ChatGPT Codex Connector
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant