Skip to content

Commit 171bc03

Browse files
hyperpolymathclaude
andcommitted
docs: bespoke architecture, roadmap, topology, and ABI definitions for anvomidaviser
Replace all template placeholders across 56+ files. Bespoke changes: - Idris2 ABI: ISU skating types (ElementCode, JumpType, SpinLevel, GOE, PCS, TechnicalScore, ProgramScore), memory layouts for scoring structs, FFI declarations for parsing, scoring, validation, and Zayak rule checking - Zig FFI: anvomidaviser_* symbol names, ISU-specific operations (parse_element, score_program, validate_program, check_zayak, check_element_count) - ROADMAP: 6 bespoke phases — ISU parser, Anvomidav codegen, scoring engine, Idris2 proofs, ecosystem integration - TOPOLOGY.md: full repository structure map with data flow diagram - README: expanded with use cases, CLI commands, example manifest - STATE/META/ECOSYSTEM: anvomidaviser-specific content and ADRs - All container, CI, community, and metadata files: placeholders resolved Architecture: ISU notation -> Anvomidav formal choreography engine. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0a35c39 commit 171bc03

58 files changed

Lines changed: 1360 additions & 546 deletions

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 anvomidaviser
55
# Base: Chainguard Wolfi (minimal, supply-chain-secure)
6-
# Build: podman build -t {{PROJECT_NAME}}-dev -f .devcontainer/Containerfile .
6+
# Build: podman build -t anvomidaviser-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/anvomidaviser
2828

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

.devcontainer/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 `anvomidaviser` 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// SPDX-License-Identifier: PMPL-1.0-or-later
22
// 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 anvomidaviser
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": "anvomidaviser",
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="anvomidaviser"
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> <6759885+hyperpolymath@users.noreply.github.com>

.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: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
TEMPLATE INSTRUCTIONS (delete this block before publishing)
66
============================================================================
77
Replace all {{PLACEHOLDER}} values:
8-
{{PROJECT_NAME}} - Your project name
8+
anvomidaviser - Your project name
99
hyperpolymath - GitHub/GitLab username or org
1010
anvomidaviser - 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)
11+
j.d.a.jewell@open.ac.uk - Email for conduct reports
12+
hyperpolymath - Name of conduct team/committee
13+
48 hours - Initial response SLA (e.g., 48 hours)
1414
2026 - Current year
1515
1616
Review and customise:
@@ -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 anvomidaviser 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 hyperpolymath 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 hyperpolymath 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 hyperpolymath 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 hyperpolymath 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
@@ -311,7 +311,7 @@ We thank these communities for their leadership in creating welcoming spaces.
311311
If you have questions about this Code of Conduct:
312312

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

317317
---

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ anvomidaviser/
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**:

.github/GOVERNANCE.md

Lines changed: 2 additions & 2 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 **anvomidaviser**.
66

77
---
88

99
## Project Governance Model
1010

11-
{{PROJECT_NAME}} follows a **Benevolent Dictator For Life (BDFL)** governance model.
11+
anvomidaviser 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

.github/MAINTAINERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Format: Name <email> (role)
55
# Replace placeholders with actual maintainer information.
66

7-
{{AUTHOR}} <{{AUTHOR_EMAIL}}> (Lead Maintainer)
7+
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> (Lead Maintainer)
88

99
# Additional maintainers:
1010
# Name <email> (role)

0 commit comments

Comments
 (0)