Repository navigation
docs: publish assurance capability matrix - #687
flyingrobots merged 21 commits into
Conversation
📝 WalkthroughWalkthroughThis PR adds a new "Assurance Capability Matrix" reference document distinguishing shipped native CLI, shipped JS/transitional, internal foundation, and concept-only assurance surfaces, then updates README, ARCHITECTURE, GUIDE, END_TO_END, topics docs, docs/README, CHANGELOG, and truth-manifest.json to reference and align with it. ChangesAssurance Capability Matrix Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/GUIDE.md`:
- Around line 171-172: The shipped-status rule in GUIDE.md should be driven by
the matrix entry, not by whether a page cites a shipped command or workflow.
Update the wording around Watson, Moriarty, and BLADE so it explicitly keys off
the matrix as the single source of truth, and adjust any nearby phrasing to
avoid using page citations as the criterion.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 6ec5a41a-64b2-4cf4-8ccc-7fe9f3f7ec2a
📒 Files selected for processing (11)
CHANGELOG.mdREADME.mddocs/ARCHITECTURE.mddocs/END_TO_END.mddocs/GUIDE.mddocs/README.mddocs/reference/assurance-capability-matrix.mddocs/topics/README.mddocs/topics/assurance-evidence.mddocs/topics/plain-wesley.mddocs/truth-manifest.json
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 45ac7fe212
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…sture docs: document security tooling posture
…ive-collisions fix(core): reject duplicate nonrepeatable directives
…aths docs: add first contributor fast paths
…e-baseline feat(xtask): add IR benchmark evidence command
…ol-mvp docs: specify external target protocol MVP
Self-Code Review Findings@codex please sanity-check these self-discovered documentation consistency findings before merge.
|
🔍 The Case of Pull Request #687Schema Sets
Schema Set
|
Activity Summary
Validation:
|
Summary
Closes #679.
Stacked on #686. This PR keeps the diff scoped to the assurance-positioning issue.
Why
The public assurance story needed a concrete source of truth that separates shipped native CLI commands, retained JavaScript workflows, Rust foundation code, and concept-only vocabulary. Without that split, Wesley's assurance language could imply more executable native capability than the current product surface provides.
Changes
docs/reference/assurance-capability-matrix.mdwith shipped native CLI, shipped JS/transitional, internal foundation, and concept/design-only states.mainpushes instead of every landedmainSHA.Method Evidence
e5867c65..github/workflows/cert-shipme.ymlpath filters and retained@wesley/holmesWatson/Moriarty executable surfaces.Tracker Hygiene
Risk
Low. This is documentation-only, but it affects public positioning. The main risk is overstating or understating assurance surfaces; the matrix now scopes each claim to an executable command or workflow.
Backout
Revert this PR or revert
e5867c65if the status taxonomy needs a different release boundary.Testing
pnpm exec prettier --check docs/GUIDE.md docs/reference/assurance-capability-matrix.md docs/topics/assurance-evidence.md docs/topics/plain-wesley.mdcargo xtask docs-checkgit diff --checkpnpm run preflightChecklist
Summary by CodeRabbit
New Features
Documentation