Skip to content

Update from code changes: 3-tier engine classification - #244

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6a1e3354
Open

Update from code changes: 3-tier engine classification#244
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6a1e3354

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Reframes the verification engines overview around the three formal engine tiers — Proof, Policy Enforcement, and Advisory — and cross-references the classification from the architecture page.

Changes

  • Rewrite engines/overview.mdx:
    • New 3-tier architecture diagram (Proof → Policy Enforcement → Advisory) producing Evidence / Decision / Analysis.
    • Per-tier sections describing the guarantee, when to use, engine list, and example output.
    • Comparison table restructured around output-guarantee (proof / decision / analysis) instead of a single accuracy number.
    • Engine selection and documentation index regrouped by tier.
  • architecture.mdx: constrain the deterministic-verification claim to supported proof domains and link to the new engine classification.

Context

Follows QWED-AI/qwed-verification#247, which formalizes the target DiagnosticResult engine classification: only proof engines emit VERIFIED + proof_ref; policy enforcement engines emit BLOCK / UNVERIFIABLE; advisory engines emit AdvisoryCheck only and can never emit VERIFIED.

@codeant-ai

codeant-ai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Skipping PR review because a bot author is detected.

If you want to trigger CodeAnt AI, comment @codeant-ai review to trigger a manual review.

@qwed-security

qwed-security Bot commented Jul 28, 2026

Copy link
Copy Markdown

QWED Security Verification Report

2 files scanned | 0 blocked | 0 warnings | 0 info | 0 suppressed | 2 verified

Engines

  • entropy_scan: ✅
  • pattern_scan: ✅

Verified Files

  • architecture.mdx
  • engines/overview.mdx

Verified by QWED — deterministic security verification. No LLM used.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
qwed-ai 🟢 Ready View Preview Jul 28, 2026, 4:13 AM

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
qwed-ai 🟡 Building Jul 28, 2026, 4:13 AM

@greptile-apps

greptile-apps Bot commented Jul 28, 2026

Copy link
Copy Markdown

Greptile Summary

Reframes verification documentation around three output-guarantee tiers.

  • Rewrites the engine overview with Proof, Policy Enforcement, and Advisory classifications, examples, comparison tables, selection guidance, and documentation links.
  • Updates the architecture page to constrain deterministic-verification claims to supported proof domains and cross-link the tier model.

Confidence Score: 2/5

The PR should not merge until its response examples and automatic guard-routing claims match the documented SDK and DiagnosticResult contracts.

The changed overview teaches invalid status values and response shapes while also implying that generic verification invokes security guards which require explicit calls, creating concrete integration and enforcement failures.

Files Needing Attention: engines/overview.mdx and architecture.mdx

Important Files Changed

Filename Overview
engines/overview.mdx Introduces the tier model, but its response examples conflict with DiagnosticResult, its automatic guard-routing claims conflict with the documented SDK, and Taint is classified inconsistently.
architecture.mdx Narrows deterministic claims and links the tier model, but retains a lifecycle status vocabulary inconsistent with DiagnosticResult.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TB
  P[Proof engines<br/>Evidence] --> E[Policy enforcement<br/>Decision]
  E --> A[Advisory engines<br/>Analysis]
Loading

Reviews (1): Last reviewed commit: "docs: sharpen SEO titles and description..." | Re-trigger Greptile

Comment thread engines/overview.mdx
Comment on lines 84 to +90
```python
# Example: fact verification is deterministic
result = client.verify_fact(
claim="Paris is in France",
context="Paris is the capital of France."
)
# Uses TF-IDF similarity + entity matching
# No LLM needed for most claims
{
"status": "BLOCK",
"engine": "ConfigGuard",
"reason": "SECRETS_DETECTED",
"decision_trace": ["match:OPENAI_API_KEY@api_key"]
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Invalid DiagnosticResult response shapes

When integrators copy these policy and advisory examples, BLOCK and ADVISORY do not match the linked DiagnosticStatus values, and the advisory data is placed outside developer_fields; this causes rejected results, unmatched status branches, or lost advisory checks.

Context Used: AGENTS.md (source)

Comment thread engines/overview.mdx
class A advisory;
```

A single verification request flows through the tiers: proof engines attempt a deterministic proof, policy enforcement engines apply runtime rules, and advisory engines contribute structured diagnostics. Only the proof tier can produce a `VERIFIED` status.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Guards are not automatically routed

When users pass retrieval contexts or MCP tool definitions to generic client.verify, this documented tier flow implies that RAGGuard or MCPPoisonGuard runs automatically, but the SDK requires explicit guard calls; relying on this flow leaves those inputs unchecked.

Context Used: AGENTS.md (source)

Comment thread engines/overview.mdx
Comment on lines +41 to +49
| Engine | Backend | Domain |
|---|---|---|
| [Math](/engines/math) | SymPy + Decimal | Arithmetic, calculus, matrices, NPV/IRR |
| [Logic](/engines/logic) | Z3 | SAT/SMT, quantifiers, BitVectors |
| [SQL](/engines/sql) | SQLGlot AST | Query structure, complexity, schema |
| [Code](/engines/code) | Multi-language AST | Python, JS, Java, Go security analysis |
| [Schema](/engines/schema) | Pydantic + Math | JSON structure + embedded calculations |
| [Stats](/engines/stats) | Pandera + Wasm | Data-frame invariants, sandboxed exec |
| Symbolic | CrossHair | Reference `DiagnosticResult` engine |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Taint tier classification is inconsistent

The primary proof-engine table omits Taint even though the documentation index below places it under Proof engines and the architecture page groups it with structural and data-flow proofs. Add it to this table or reclassify the other references so readers can determine which output guarantee applies.

Context Used: AGENTS.md (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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