Skip to content

Commit 3660ae4

Browse files
hyperpolymathclaude
andcommitted
feat: complete VQL-UT repo overhaul — documentation, ABI/FFI, architecture, PanLL
Major overhaul transforming vql-ut from RSR template skeleton into a fully documented, production-quality project: **ABI/FFI (real implementation):** - Idris2 ABI: 10 SafetyLevel tags, 11 VqlUtError codes, QueryMode, QueryPlanHeader with roundtrip proofs and layout verification - Zig FFI: 5-stage pipeline (parse→bind→check→effects→compile), thread-safe 256-slot context pool, 11 unit tests passing - All ~83 placeholder tokens replaced with real VQL-UT identifiers **Educational documentation (A-Level accessible):** - WHY-TYPE-SAFETY-MATTERS: horror stories (Therac-25, Equifax, Knight Capital), real-world analogies, safe/unsafe code examples - WHAT-IS-VERISIMDB: octad concept, 6 modalities, 3 query paths - THE-10-LEVELS-EXPLAINED: detailed walkthrough with TypeLL foundation - GLOSSARY: 30+ terms in plain English - FAQ: 8 questions including performance, comparison, roadmap **Architecture:** - ARCHITECTURE: 6-stage pipeline, technology stack, proof certificates - TOPOLOGY: ecosystem positioning, deployment tiers - DECISIONS: 4 ADRs (Idris2 over Lean, 10 levels, VQL-DT supersession, ReScript parser) - QUICKSTART: prerequisites, build, example walkthrough - CONTRIBUTING: real contribution guide with code standards **PanLL integration:** - panels/manifest.json: 4 panels (safety dashboard, query editor, proof explorer, horror stories) - panels/clade.a2ml: database-tooling clade with 6 capabilities **Infrastructure:** - All container, CI, SCM, workflow files de-placeholdered - 15 src/ README stubs replaced with real descriptions - .gitignore updated for Zig build artifacts Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 83c4824 commit 3660ae4

109 files changed

Lines changed: 6357 additions & 1158 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer/Containerfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# SPDX-License-Identifier: PMPL-1.0-or-later
2-
# Copyright (c) {{CURRENT_YEAR}} {{AUTHOR}} ({{OWNER}}) <{{AUTHOR_EMAIL}}>
2+
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
33
#
4-
# Dev Container image for {{PROJECT_NAME}}
4+
# Dev Container image for VQL-UT
55
# Base: Chainguard Wolfi (minimal, supply-chain-secure)
6-
# Build: podman build -t {{PROJECT_NAME}}-dev -f .devcontainer/Containerfile .
6+
# Build: podman build -t VQL-UT-dev -f .devcontainer/Containerfile .
77

88
FROM cgr.dev/chainguard/wolfi-base:latest
99

@@ -24,7 +24,7 @@ RUN groupadd -g 1000 nonroot || true \
2424
&& useradd -m -u 1000 -g 1000 -s /bin/bash nonroot || true
2525

2626
# Set workspace directory
27-
WORKDIR /workspaces/{{PROJECT_NAME}}
27+
WORKDIR /workspaces/VQL-UT
2828

2929
# Default shell
3030
ENV SHELL=/bin/bash

.devcontainer/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// SPDX-License-Identifier: PMPL-1.0-or-later
22
= Dev Container Usage
3-
:author: {{AUTHOR}} <{{AUTHOR_EMAIL}}>
3+
:author: Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44

55
== Overview
66

@@ -24,4 +24,4 @@ This dev container uses `cgr.dev/chainguard/wolfi-base` with git, curl, bash, an
2424

2525
== Customization
2626

27-
Replace `{{PROJECT_NAME}}` placeholders in both `devcontainer.json` and `Containerfile` with your actual project name. Run `just deps` to verify the environment after first launch.
27+
Replace `VQL-UT` placeholders in both `devcontainer.json` and `Containerfile` with your actual project name. Run `just deps` to verify the environment after first launch.

.devcontainer/devcontainer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// SPDX-License-Identifier: PMPL-1.0-or-later
2-
// Copyright (c) {{CURRENT_YEAR}} {{AUTHOR}} ({{OWNER}}) <{{AUTHOR_EMAIL}}>
2+
// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
33
//
4-
// Dev Container configuration for {{PROJECT_NAME}}
4+
// Dev Container configuration for VQL-UT
55
// Works with: VS Code Dev Containers, GitHub Codespaces, Gitpod
66
// Container runtime: Podman (recommended) or any OCI-compliant runtime
77
{
8-
"name": "{{PROJECT_NAME}}",
8+
"name": "VQL-UT",
99

1010
"build": {
1111
"dockerfile": "Containerfile",

.envrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ if has nix && [ -f flake.nix ]; then
1818
fi
1919

2020
# Project environment variables
21-
export PROJECT_NAME="{{PROJECT_NAME}}"
21+
export PROJECT_NAME="VQL-UT"
2222
export RSR_TIER="infrastructure"
2323
# export DATABASE_URL="..."
2424
# export API_KEY="..."

.github/.mailmap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{AUTHOR}} <{{AUTHOR_EMAIL}}> <{{AUTHOR_EMAIL_ALT}}>
1+
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> <>

.github/CODEOWNERS

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
# CODEOWNERS - Define code review assignments
33
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
44
#
5-
# Replace {{OWNER}} with your GitHub username or team
5+
# Replace hyperpolymath with your GitHub username or team
66

77
# Default owners for everything
8-
* @{{OWNER}}
8+
* @hyperpolymath
99

1010
# Security-sensitive files require explicit review
11-
SECURITY.md @{{OWNER}}
12-
.github/workflows/ @{{OWNER}}
13-
Trustfile.a2ml @{{OWNER}}
14-
.machine_readable/ @{{OWNER}}
11+
SECURITY.md @hyperpolymath
12+
.github/workflows/ @hyperpolymath
13+
Trustfile.a2ml @hyperpolymath
14+
.machine_readable/ @hyperpolymath

.github/CODE_OF_CONDUCT.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
TEMPLATE INSTRUCTIONS (delete this block before publishing)
66
============================================================================
77
Replace all {{PLACEHOLDER}} values:
8-
{{PROJECT_NAME}} - Your project name
9-
{{OWNER}} - GitHub/GitLab username or org
10-
{{REPO}} - Repository name
11-
{{CONDUCT_EMAIL}} - Email for conduct reports
12-
{{CONDUCT_TEAM}} - Name of conduct team/committee
13-
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
14-
{{CURRENT_YEAR}} - Current year
8+
VQL-UT - Your project name
9+
hyperpolymath - GitHub/GitLab username or org
10+
vql-ut - Repository name
11+
j.d.a.jewell@open.ac.uk - Email for conduct reports
12+
Code of Conduct Committee - Name of conduct team/committee
13+
48 hours - Initial response SLA (e.g., 48 hours)
14+
2026 - Current year
1515
1616
Review and customise:
1717
- Adjust enforcement ladder for your community size
@@ -22,7 +22,7 @@ Review and customise:
2222

2323
## Our Pledge
2424

25-
We as members, contributors, and leaders pledge to make participation in {{PROJECT_NAME}} a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
25+
We as members, contributors, and leaders pledge to make participation in VQL-UT a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
2626

2727
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
2828

@@ -136,7 +136,7 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
136136

137137
| Method | Details | Best For |
138138
|--------|---------|----------|
139-
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
139+
| **Email** | j.d.a.jewell@open.ac.uk | Detailed reports, sensitive matters |
140140
| **Private Message** | Contact any maintainer directly | Quick questions, minor issues |
141141
| **Anonymous Form** | [Link to form if available] | When you need anonymity |
142142

@@ -152,8 +152,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
152152

153153
**What Happens Next**
154154

155-
1. You will receive acknowledgment within **{{RESPONSE_TIME}}**
156-
2. The {{CONDUCT_TEAM}} will review the report
155+
1. You will receive acknowledgment within **48 hours**
156+
2. The Code of Conduct Committee will review the report
157157
3. We may ask for additional information
158158
4. We will determine appropriate action
159159
5. We will inform you of the outcome (respecting others' privacy)
@@ -169,7 +169,7 @@ All reports will be handled with discretion:
169169

170170
### Conflicts of Interest
171171

172-
If a {{CONDUCT_TEAM}} member is involved in an incident:
172+
If a Code of Conduct Committee member is involved in an incident:
173173

174174
- They will recuse themselves from the process
175175
- Another maintainer or external party will handle the report
@@ -179,7 +179,7 @@ If a {{CONDUCT_TEAM}} member is involved in an incident:
179179

180180
## Enforcement Guidelines
181181

182-
The {{CONDUCT_TEAM}} will follow these guidelines in determining consequences:
182+
The Code of Conduct Committee will follow these guidelines in determining consequences:
183183

184184
### 1. Correction
185185

@@ -231,13 +231,13 @@ For contributors with elevated access (Perimeter 2 or 1):
231231
If you believe an enforcement decision was made in error:
232232

233233
1. **Wait 7 days** after the decision (cooling-off period)
234-
2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]"
234+
2. **Email** j.d.a.jewell@open.ac.uk with subject line "Appeal: [Original Report ID]"
235235
3. **Explain** why you believe the decision should be reconsidered
236236
4. **Provide** any new information not previously available
237237

238238
**Appeals Process**
239239

240-
- Appeals are reviewed by a different {{CONDUCT_TEAM}} member than the original
240+
- Appeals are reviewed by a different Code of Conduct Committee member than the original
241241
- You will receive a response within 14 days
242242
- The appeals decision is final
243243
- You may only appeal once per incident
@@ -310,8 +310,8 @@ We thank these communities for their leadership in creating welcoming spaces.
310310

311311
If you have questions about this Code of Conduct:
312312

313-
- Open a [Discussion](https://{{FORGE}}/{{OWNER}}/{{REPO}}/discussions) (for general questions)
314-
- Email {{CONDUCT_EMAIL}} (for private questions)
313+
- Open a [Discussion](https://github.com/hyperpolymath/vql-ut/discussions) (for general questions)
314+
- Email j.d.a.jewell@open.ac.uk (for private questions)
315315
- Contact any maintainer directly
316316

317317
---
@@ -324,4 +324,4 @@ We're all here because we care about this project. Let's make it a place where e
324324

325325
---
326326

327-
<sub>Last updated: {{CURRENT_YEAR}} · Based on Contributor Covenant 2.1</sub>
327+
<sub>Last updated: 2026 · Based on Contributor Covenant 2.1</sub>

.github/CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Clone the repository
2-
git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git
3-
cd {{REPO}}
2+
git clone https://github.com/hyperpolymath/vql-ut.git
3+
cd vql-ut
44

55
# Using Nix (recommended for reproducibility)
66
nix develop
77

88
# Or using toolbox/distrobox
9-
toolbox create {{REPO}}-dev
10-
toolbox enter {{REPO}}-dev
9+
toolbox create vql-ut-dev
10+
toolbox enter vql-ut-dev
1111
# Install dependencies manually
1212

1313
# Verify setup
@@ -17,7 +17,7 @@ just test # Run test suite
1717
1818
### Repository Structure
1919
```
20-
{{REPO}}/
20+
vql-ut/
2121
├── src/ # Source code (Perimeter 1-2)
2222
├── lib/ # Library code (Perimeter 1-2)
2323
├── extensions/ # Extensions (Perimeter 2)
@@ -58,7 +58,7 @@ just test # Run test suite
5858
5959
**Before reporting**:
6060
1. Search existing issues
61-
2. Check if it's already fixed in `{{MAIN_BRANCH}}`
61+
2. Check if it's already fixed in `main`
6262
3. Determine which perimeter the bug affects
6363
6464
**When reporting**:
@@ -91,10 +91,10 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an
9191
9292
Look for issues labelled:
9393
94-
- [`good first issue`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/good%20first%20issue) — Simple Perimeter 3 tasks
95-
- [`help wanted`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/help%20wanted) — Community help needed
96-
- [`documentation`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/documentation) — Docs improvements
97-
- [`perimeter-3`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/perimeter-3) — Community sandbox scope
94+
- [`good first issue`](https://github.com/hyperpolymath/vql-ut/labels/good%20first%20issue) — Simple Perimeter 3 tasks
95+
- [`help wanted`](https://github.com/hyperpolymath/vql-ut/labels/help%20wanted) — Community help needed
96+
- [`documentation`](https://github.com/hyperpolymath/vql-ut/labels/documentation) — Docs improvements
97+
- [`perimeter-3`](https://github.com/hyperpolymath/vql-ut/labels/perimeter-3) — Community sandbox scope
9898
9999
---
100100

.github/FUNDING.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SPDX-License-Identifier: PMPL-1.0-or-later
2-
# Funding platforms for {{OWNER}} projects
2+
# Funding platforms for hyperpolymath projects
33
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository
44

5-
github: {{OWNER}}
6-
ko_fi: {{OWNER}}
7-
liberapay: {{OWNER}}
5+
github: hyperpolymath
6+
ko_fi: hyperpolymath
7+
liberapay: hyperpolymath

.github/GOVERNANCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
# Project Governance
44

5-
This document describes the governance model for **{{PROJECT_NAME}}**.
5+
This document describes the governance model for **VQL-UT**.
66

77
---
88

99
## Project Governance Model
1010

11-
{{PROJECT_NAME}} follows a **Benevolent Dictator For Life (BDFL)** governance model.
11+
VQL-UT follows a **Benevolent Dictator For Life (BDFL)** governance model.
1212
This model is well-suited for solo maintainers and small project teams where rapid,
1313
consistent decision-making is more valuable than formal consensus processes.
1414

@@ -155,4 +155,4 @@ with the community before adoption, even though the BDFL retains final authority
155155

156156
---
157157

158-
<sub>Copyright (c) {{CURRENT_YEAR}} {{OWNER}}. Licensed under PMPL-1.0-or-later.</sub>
158+
<sub>Copyright (c) 2026 hyperpolymath. Licensed under PMPL-1.0-or-later.</sub>

0 commit comments

Comments
 (0)