Skip to content

docs: VCL rename — bare-VQL doc-token sweep (#84)#143

Merged
hyperpolymath merged 1 commit into
mainfrom
vcl/rename-doc-token-sweep
Jun 14, 2026
Merged

docs: VCL rename — bare-VQL doc-token sweep (#84)#143
hyperpolymath merged 1 commit into
mainfrom
vcl/rename-doc-token-sweep

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Doc-token sweep — the documentation half of the #84 VQL→VCL rename

Staged separately from code, per the repo's own doc-consonance policy (tests/doc-consonance-gate.sh): that gate only forbids the phrase "VeriSim Query Language"; code identifiers and CHANGELOG history are explicitly out of scope and tracked under #84. This PR does the prose half and keeps the gate green.

Renamed across 50 prose docs (.adoc/.md)

  • Language name VQLVCL (incl. VQL-DTVCL-DT where it names the language); [source,vql] / ```vql fence tags → vcl.
  • Stale Stage-C Elixir identifiers updated to match the merged reality of refactor(elixir): VCL rename stage C — VQL* modules → VCL* (#84) #136: vql_{executor,bridge,type_checker,proof_certificate}.exvcl_*.ex; VeriSim.Query.VQL{Executor,Bridge,TypeChecker,ProofCertificate}VCL*.

Deliberately preserved → Stage B (unrenamed code + wire contracts)

Distinguished cleanly by file-suffix (.res/.rs/.jl/.zig vs Stage-C's .ex):

  • ReScript src/vql/VQL*.res, VeriSimVql, VqlKeywords
  • Rust vql.rs / vql_bridge.rs / vql_fmt.rs, Julia vql.jl, Zig vql.zig
  • fuzz target fuzz_vql_parser, .vql example files, examples/vql-queries
  • API path /api/v1/vql/execute, header X-VQL-Version, type:vql_query search tag
  • CHANGELOG.adoc (allow-listed history), docs/papers/*.{tex,bib} (citation-key integrity), *.a2ml machine-readable metadata

Verification

  • doc-consonance-gate.sh stays GREEN (no banned misnomer phrase introduced)
  • ✅ no vql/vcl-based AsciiDoc xref:/<<>>/anchor breakage (checked)
  • ✅ every residual vql token is an intentionally-preserved Stage-B identifier/contract (grep-classified)
  • ✅ no wrongly-created vcl code-path tokens (the only new X-VCL-*/text/vcl are illustrative headers in an architecture-doc snippet — confirmed absent from code)
  • ✅ symmetric 533/533 diff — pure equal-length token swaps, zero structural change

Refs #84. Pure-docs change (no code, no CHANGELOG, no .a2ml), so no compile/test impact; the governance / Code quality + docs gate is the relevant check.


Generated by Claude Code

Sweeps the documentation-prose half of the VQL->VCL rename, staged
separately from code per the repo's own doc-consonance policy
(tests/doc-consonance-gate.sh: code identifiers and changelog history are
out of scope for the docs gate and tracked under #84).

Renamed across 50 prose docs (.adoc/.md):
- Language name "VQL" -> "VCL" (incl. "VQL-DT" -> "VCL-DT" where it names
  the language); [source,vql] / ```vql fence tags -> vcl.
- Stale Stage-C Elixir identifiers updated to match merged reality (#136):
  vql_{executor,bridge,type_checker,proof_certificate}.ex -> vcl_*.ex;
  VeriSim.Query.VQL{Executor,Bridge,TypeChecker,ProofCertificate} -> VCL*.

Deliberately preserved (unrenamed code + wire contracts -> Stage B):
- ReScript src/vql/VQL*.res, VeriSimVql, VqlKeywords
- Rust vql.rs / vql_bridge.rs / vql_fmt.rs, Julia vql.jl, Zig vql.zig
- fuzz target fuzz_vql_parser, .vql example files, examples/vql-queries
- API path /api/v1/vql/execute, header X-VQL-Version, type:vql_query tag
- CHANGELOG.adoc (allow-listed history), docs/papers/*.{tex,bib} (citation
  integrity), *.a2ml machine-readable metadata

Verified: doc-consonance gate stays GREEN (no "VeriSim Query Language"
misnomer); no vql/vcl xref or anchor breakage; every residual "vql" token
is an intentionally-preserved Stage-B identifier/contract; symmetric
533/533 diff (equal-length token swaps, no structural change).

Refs #84.

https://claude.ai/code/session_01W9Voe3JceP66Bna9FT4jME
@hyperpolymath hyperpolymath marked this pull request as ready for review June 14, 2026 01:11
@hyperpolymath hyperpolymath enabled auto-merge (squash) June 14, 2026 01:12
@github-actions

Copy link
Copy Markdown

🔍 Hypatia Security Scan

Findings: 134 issues detected

Severity Count
🔴 Critical 17
🟠 High 51
🟡 Medium 66

⚠️ Action Required: Critical security issues found!

View findings
[
  {
    "reason": "Issue in scorecard-enforcer.yml",
    "type": "scorecard_publish_with_run_step",
    "file": "scorecard-enforcer.yml",
    "action": "split_scorecard_publish_job",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Issue in instant-sync.yml",
    "type": "secret_action_without_presence_gate",
    "file": "instant-sync.yml",
    "action": "peter-evans/repository-dispatch",
    "rule_module": "workflow_audit",
    "severity": "high"
  },
  {
    "reason": "Issue in codeql.yml",
    "type": "codeql_missing_actions_language",
    "file": "codeql.yml",
    "action": "flag",
    "rule_module": "workflow_audit",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (1 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/Provenance.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (2 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/PlannerSemantic.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (1 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/Planner.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (6 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/Drift.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (1 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/WAL.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "User-defined Coq axiom -- not verified by kernel (2 occurrences, CWE-704)",
    "type": "coq_axiom",
    "file": "/home/runner/work/verisimdb/verisimdb/formal/Normalizer.v",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "medium"
  },
  {
    "reason": "getExn on external data -- use pattern matching (1 occurrences, CWE-754)",
    "type": "getexn_on_external",
    "file": "/home/runner/work/verisimdb/verisimdb/src/registry/Registry.res",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "critical"
  }
]

Powered by Hypatia Neurosymbolic CI/CD Intelligence

@hyperpolymath hyperpolymath disabled auto-merge June 14, 2026 01:13
@hyperpolymath hyperpolymath merged commit 7dedbb2 into main Jun 14, 2026
38 checks passed
@hyperpolymath hyperpolymath deleted the vcl/rename-doc-token-sweep branch June 14, 2026 01:13
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.

2 participants