Revise README.md for clarity and additional information

[flyingrobots]

Updated README.md to include new sections and clarify existing content.

Summary

• What problem does this PR solve? Link issues/PRs.

Why

• Rationale for this approach. Mention alternatives considered and trade‑offs.

Changes

• Bulleted list of focused changes (keep it surgical).

Risk

• User‑facing or CI risk and mitigations. Rollout/enablement notes if any.

Backout

• How to revert safely; follow‑up cleanup if rollback happens.

Testing

• Rust core/CLI: cargo xtask preflight
• Core fixtures: cargo test --manifest-path crates/wesley-core/Cargo.toml
• Legacy package surfaces: cargo xtask legacy-preflight (when touching packages/, docs checks, or JS tooling)
• JS package focus: pnpm -w -F <package> test (only for legacy package changes)

EvidenceMap / SourceMap (if applicable)

• Confirm UIDs use tbl:Table and col:Table.field.
• If mapping SQL→SDL, verify .wesley-cache/bundle.json exists and SourceMap finds SDL.

Screenshots / Logs (optional)

Merge Strategy

• Merge commit only; no rebase.
• Delete branch after merge.

Checklist

• One‑topic PR with tight diff
• Rust-native preflight passes (cargo xtask preflight)
• Legacy package preflight passes when relevant (cargo xtask legacy-preflight)
• No widened permissions/secrets in workflows
• Docs updated if behavior changed

Summary by CodeRabbit

• Documentation
  • Restructured README to emphasize architectural principles and core compilation concepts, replacing usage-focused sections. Added guidance on module responsibilities, layer separation, and compile-time enforcement.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 96976a6f-06de-45b7-8ff0-072034bca026

📥 Commits

Reviewing files that changed from the base of the PR and between 79fac72 and a2ced78.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README is substantially rewritten to reposition Wesley from a practical tool with quick-start guidance to a semantic contract compiler with formalized architectural doctrine. It replaces usage-focused sections with conceptual principles, compilation model, extension architecture, boundary statements, and current grounding.

Changes

README Doctrine and Architecture Overhaul

Layer / File(s)	Summary
Wesley's positioning and core doctrine README.md	New hero header and opening epigraph establish Wesley as a semantic contract compiler. Introduction defines semantic ownership boundaries, core flow concepts, and the inversion from GraphQL SDL to semantic graphs and emitted artifacts.
Compilation model and extension architecture README.md	"Why GraphQL" rationale and deterministic compilation model with L1/L2/L3 semantics. Extension module responsibilities table and Shape vs Law explanation show how directives are interpreted vs ignored by extensions.
Boundaries and deep principles README.md	Deep end guidance on static analyzability and compile-time enforcement of operation footprints. Rewritten layer separation doctrine with trap-detection rules and explicit anti-goals defining what Wesley is not.
Current grounding and final doctrine README.md	Current grounding section with witnessed execution seam flowchart. Rewritten final doctrine summarizing core principles, replacing prior quick-start commands, release notes, and package matrix documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• flyingrobots/wesley#475: Both PRs overlap on README/documentation rewrite and broader documentation and architecture signpost changes.

Suggested labels

enhancement

Poem

🐰 Wesley's words now dance with deeper grace,
From quick-start haste to doctrine's embrace,
A compiler's creed, semantically sound,
Where schema meets law on principle's ground.
The README reborn—now crystal and clear! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch flyingrobots-patch-1

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🔍 The Case of Pull Request #503

Plain-English Readout

• Holmes (evidence investigation): Holmes says this change should not ship in its current state. Main reasons: No evidence citations were available for trust analysis; test evidence is incomplete; schema coverage is incomplete.
• Watson (independent verification): Watson found verification concerns. Most important concern: Low migration risk claimed but schema incomplete.
• Moriarty (trend forecast): Moriarty sees progress as stalled right now, so forecast confidence is limited.

Suggested next actions

1. Tighten citations so the report points to exact lines instead of whole files or coarse references.
2. Resolve Watson’s verification concerns before trusting the Holmes verdict as final.
3. Treat the readiness forecast as stalled until new evidence or real progress moves the trend again.
4. Add or strengthen tests for the schema elements and operations HOLMES flagged as weakly proven.

📚 Glossary (what the Holmes terms mean)

• HOLMES: Wesley’s main evidence investigation. It decides whether the cited proof is strong enough to justify shipping this commit.
• WATSON: An independent verification pass. It checks Holmes’s citations and score math instead of trusting them blindly.
• MORIARTY: A readiness forecast over time. It is advisory trend analysis, not the release gate itself.
• Schema coverage score (SCS): How much of the schema has direct supporting evidence across generated artifacts and cited proof.
• Test confidence index (TCI): How much test evidence exists for constraints, policies, relationships, and operations.
• Migration risk index (MRI): How risky the schema change is to roll out. Lower is better.
• Evidence trust: Whether the report is backed by exact citations, whole-file citations, or coarse references. Weak trust means the claim may be directionally right but not specific enough to trust blindly.
• Citation quality: A count of exact line-span citations versus whole-file or coarse references.
• ELEMENTARY: Ready to ship based on the current evidence.
• REQUIRES INVESTIGATION: More work or review is needed before shipping.
• YOU SHALL NOT PASS: Do not ship this change in its current state.

---

🕵️ SHA-lock HOLMES full report (click to expand)

🕵️ SHA-lock HOLMES Investigation

• Generated: 2026-05-12T03:58:13.598Z
• Commit SHA: 44da64e
• Bundle Version: 2.0.0

⚠️ Evidence valid only for commit 44da64e

🔍 Executive Deduction

"Watson, after careful examination of the evidence, I deduce..."

Weighted Completion: ░░░░░░░░░░ 0.0%
Scores: SCS 0.0% · TCI 0.0% · MRI 0.0%
Verification Status: 0 claims verified
Citation Quality: 0 exact · 0 whole-file · 0 coarse
Evidence Trust: missing
Ship Verdict: YOU SHALL NOT PASS

🧩 SCS Breakdown

Component	Score	Coverage
Sql	0.0%	0.00/154.00
Types	0.0%	0.00/154.00
Validation	0.0%	0.00/154.00
Tests	0.0%	0.00/154.00

🧪 TCI Breakdown

Component	Score	Coverage	Note
Unit Constraints	0.0%	0/104	N/A
Unit Rls	0.0%	—	N/A
Integration Relations	0.0%	0/3	N/A
E2e Ops	N/A	—	Query operation test tracking not yet implemented

⚠️ MRI Breakdown

Component	Risk Share	Points	Count
Drops	0%	0	0
Renames Without Uid	0%	0	0
Add Not Null Without Default	0%	0	0
Non Concurrent Indexes	0%	0	0

📊 The Weight of Evidence

"Observe, Watson, how not all features carry equal importance..."

Element	Weight	Status	Evidence	Strength	Deduction

🚪 Security & Performance Gates

"Elementary security measures, Watson..."

Gate	Status	Evidence	Holmes's Ruling
Migration Risk	✅	MRI: 0.0%	"Trivial risk"
Test Coverage	⚠️	TCI: 0.0%	"Theatrical tests!"
Sensitive Fields	✅	0 fields	"All secured"
Evidence Quality	⛔	0 exact · 0 whole-file · 0 coarse	"No evidence citations were available for trust analysis."

📋 The Verdict

⛔ YOU SHALL NOT PASS
"Critical evidence is missing! Return to your laboratory!"

Signed and sealed,

• S. Holmes, Consulting Detective

[END OF INVESTIGATION FOR COMMIT 44da64e]

🧵 Command Run

• Run ID: run-mp23pb9d-i8icpm
• Transmutation: holmes-investigate
• Command: investigate
• Status: completed
• Ledger: /home/runner/work/wesley/wesley/test/fixtures/examples/.wesley-cache/ledger

---

🩺 Dr. WATSON full report (click to expand)

🩺 Dr. Watson's Independent Verification Report

Medical Examination of Evidence

• Examination Date: 2026-05-12T03:59:11.992Z
• Patient SHA: 44da64e

🔬 Citation Verification

"Let me examine each piece of evidence independently..."

• Citations Examined: 0
• Verified: 0 ✅
• Failed: 0 ❌
• Unable to Verify: 0
• Exact Subrange Citations: 0
• Whole-file Citations: 0
• Coarse Citations: 0
• Evidence Trust: missing
• Trust Note: No evidence citations were available for trust analysis.

Verification Rate: 0.0%

📊 Mathematical Verification

"I shall recalculate Holmes's arithmetic..."

Holmes claimed SCS: 0.0%
Watson calculates: 0.0%
Difference: ✅ Negligible

🔍 Consistency Analysis

"Checking for contradictions in Holmes's deductions..."

⚠️ Low migration risk claimed but schema incomplete

🩺 Dr. Watson's Medical Opinion

VERIFICATION: CONCERNS NOTED ⚠️

"While Holmes's methods are generally sound, I have noted some"
"discrepancies that warrant further investigation. No evidence citations were available for trust analysis."

Respectfully submitted,

• Dr. J. Watson, M.D.
  Medical Examiner & Verification Specialist

🧵 Command Run

• Run ID: run-mp23pze5-u09gth
• Transmutation: watson-verify
• Command: verify
• Status: completed
• Ledger: /home/runner/work/wesley/wesley/test/fixtures/examples/.wesley-cache/ledger

---

🔮 Professor MORIARTY full report (click to expand)

🧠 Professor Moriarty's Temporal Predictions

The Mathematics of Inevitability

• Analysis Date: 2026-05-12T03:59:50.985Z

🔮 Current State

SCS: ░░░░░░░░░░ 0.0%
TCI: ░░░░░░░░░░ 0.0%
MRI: 0.0% risk
Evidence Trust: missing

📈 Velocity Analysis

SCS Velocity: +0.00%/day
Git Activity (window): 24h · commits 3 (2 relevant) · ~3.00 commits/day
↳ Magnitude: ~179 relevant LOC/day across ~1.0 files/day
Activity Index: 17 / 100 (PR 0, Window 43)
Blended Velocity: +0.10%/day
Commit Size Burstiness: 66 / 100 (higher = more uneven commit sizes)
⚠️ PLATEAU DETECTED - Low SCS movement and low recent Git activity.

⏰ Completion Predictions

ETA: Cannot predict (insufficient velocity)

"At current velocity, completion is... improbable."

⚠️ Warnings

• Evidence trust is missing; No evidence citations were available for trust analysis.

🧪 Readiness EXPLAIN

• SCS ≥ 80% → FAIL ❌ (actual 0.0%)
• TCI ≥ 70% → FAIL ❌ (actual 0.0%)
• MRI ≤ 40% → PASS ✅ (actual 0.0%)
• CI Stability ≥ 90% (branch main) → FAIL ❌ (actual 88% over ~168h)
• Evidence Trust ≥ moderate → FAIL ❌ (actual missing) — No evidence citations were available for trust analysis.
• Delivery context (last 168h): 0 issues closed · 5 PRs merged (informational, not gating)

Signals blend: SCS velocity (70%) + Git activity (30%, branch-first). Activity only suppresses false plateaus; it never inflates readiness.

📊 Historical Trajectory

05-12: ░░░░░░░░░░ 0.0%
05-12: ░░░░░░░░░░ 0.0%
05-12: ░░░░░░░░░░ 0.0%

"Every problem becomes elementary when reduced to mathematics"
— Professor Moriarty

🧵 Command Run

• Run ID: run-mp23qthj-msu061
• Transmutation: moriarty-predict
• Command: predict
• Status: completed
• Ledger: /home/runner/work/wesley/wesley/test/fixtures/examples/.wesley-cache/ledger

---

Machine-readable reports: holmes-report.json · watson-report.json · moriarty-report.json (see workflow artifacts).

---

Filed at 221B Repository Street