From 02b7f96e1a150a9bce9079e9552fbb7120c5629d Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Mon, 24 Aug 2026 07:53:22 +0100 Subject: [PATCH] refactor: migrate repository documentation from Markdown to AsciiDoc --- CODE_OF_CONDUCT.adoc | 24 +++++++ CODE_OF_CONDUCT.md | 27 -------- CONTRIBUTING.adoc | 71 +++++++++++++++++++ CONTRIBUTING.md | 66 ------------------ README.adoc | 123 +++++++++++++++++++++++++++++++++ README.md | 130 ----------------------------------- REQUIRES_INITIALISATION.adoc | 120 ++++++++++++++++++++++++++++++++ REQUIRES_INITIALISATION.md | 118 ------------------------------- SECURITY.adoc | 25 +++++++ SECURITY.md | 21 ------ TEST-NEEDS.adoc | 34 +++++++++ TEST-NEEDS.md | 31 --------- TOPOLOGY.md => TOPOLOGY.adoc | 41 +++++------ llm-warmup-dev.adoc | 19 +++++ llm-warmup-dev.md | 16 ----- llm-warmup-user.adoc | 19 +++++ llm-warmup-user.md | 16 ----- 17 files changed, 456 insertions(+), 445 deletions(-) create mode 100644 CODE_OF_CONDUCT.adoc delete mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.adoc delete mode 100644 CONTRIBUTING.md create mode 100644 README.adoc delete mode 100644 README.md create mode 100644 REQUIRES_INITIALISATION.adoc delete mode 100644 REQUIRES_INITIALISATION.md create mode 100644 SECURITY.adoc delete mode 100644 SECURITY.md create mode 100644 TEST-NEEDS.adoc delete mode 100644 TEST-NEEDS.md rename TOPOLOGY.md => TOPOLOGY.adoc (88%) create mode 100644 llm-warmup-dev.adoc delete mode 100644 llm-warmup-dev.md create mode 100644 llm-warmup-user.adoc delete mode 100644 llm-warmup-user.md diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc new file mode 100644 index 0000000..bd2a83c --- /dev/null +++ b/CODE_OF_CONDUCT.adoc @@ -0,0 +1,24 @@ +== Contributor Covenant Code of Conduct + +=== Our Pledge + +We pledge to make participation a harassment-free experience for +everyone. + +=== Our Standards + +*Positive behavior:* * Using welcoming language * Being respectful of +differing viewpoints * Accepting constructive criticism * Focusing on +what is best for the community + +*Unacceptable behavior:* * Harassment, trolling, or personal attacks * +Publishing private information without permission + +=== Enforcement + +Report issues to the maintainers. All complaints will be reviewed. + +=== Attribution + +Adapted from https://www.contributor-covenant.org/[Contributor Covenant] +v2.1. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index caeda1c..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Contributor Covenant Code of Conduct - -## Our Pledge - -We pledge to make participation a harassment-free experience for everyone. - -## Our Standards - -**Positive behavior:** -* Using welcoming language -* Being respectful of differing viewpoints -* Accepting constructive criticism -* Focusing on what is best for the community - -**Unacceptable behavior:** -* Harassment, trolling, or personal attacks -* Publishing private information without permission - -## Enforcement - -Report issues to the maintainers. All complaints will be reviewed. - -## Attribution - -Adapted from [Contributor Covenant](https://www.contributor-covenant.org/) v2.1. - diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..dd089ae --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,71 @@ +== Contributing + +Thank you for your interest in contributing! We follow a "`Dual-Track`" +architecture where human-readable documentation lives in the root and +machine-readable policies live in `+.machine_readable/+`. + +=== How to Contribute + +We welcome contributions in many forms: + +* *Code:* Improving the core stack or extensions +* *Documentation:* Enhancing docs or AI manifests +* *Testing:* Adding property-based tests or formal proofs +* *Bug reports:* Filing clear, reproducible issues + +=== Getting Started + +[arabic] +. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` (if present) +to understand the repository structure. +. *Environment:* Use `+guix develop+` or `+direnv allow+` to set up your +tools. +. *Task Runner:* Use `+just+` to see available commands +(`+just --list+`). + +=== Development Workflow + +==== Branch Naming + +.... +docs/short-description # Documentation +test/what-added # Test additions +feat/short-description # New features +fix/issue-number-description # Bug fixes +refactor/what-changed # Code improvements +security/what-fixed # Security fixes +.... + +==== Commit Messages + +We follow https://www.conventionalcommits.org/[Conventional Commits]: + +.... +(): + +[optional body] + +[optional footer] +.... + +Types: `+feat+`, `+fix+`, `+docs+`, `+test+`, `+refactor+`, `+ci+`, +`+chore+`, `+security+` + +=== Reporting Bugs + +Before reporting: 1. Search existing issues 2. Check if it’s already +fixed in `+main+` + +When reporting, include: - Clear, descriptive title - Environment +details (OS, versions, toolchain) - Steps to reproduce - Expected vs +actual behaviour + +=== Code of Conduct + +All contributors are expected to adhere to our +link:CODE_OF_CONDUCT.md[Code of Conduct]. + +=== License + +By contributing, you agree that your contributions will be licensed +under the same license as the project (see LICENSE). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 90e87dc..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,66 +0,0 @@ - -# Contributing - -Thank you for your interest in contributing! We follow a "Dual-Track" architecture where human-readable documentation lives in the root and machine-readable policies live in `.machine_readable/`. - -## How to Contribute - -We welcome contributions in many forms: - -- **Code:** Improving the core stack or extensions -- **Documentation:** Enhancing docs or AI manifests -- **Testing:** Adding property-based tests or formal proofs -- **Bug reports:** Filing clear, reproducible issues - -## Getting Started - -1. **Read the AI Manifest:** Start with `0-AI-MANIFEST.a2ml` (if present) to understand the repository structure. -2. **Environment:** Use `guix develop` or `direnv allow` to set up your tools. -3. **Task Runner:** Use `just` to see available commands (`just --list`). - -## Development Workflow - -### Branch Naming - -``` -docs/short-description # Documentation -test/what-added # Test additions -feat/short-description # New features -fix/issue-number-description # Bug fixes -refactor/what-changed # Code improvements -security/what-fixed # Security fixes -``` - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): - -``` -(): - -[optional body] - -[optional footer] -``` - -Types: `feat`, `fix`, `docs`, `test`, `refactor`, `ci`, `chore`, `security` - -## Reporting Bugs - -Before reporting: -1. Search existing issues -2. Check if it's already fixed in `main` - -When reporting, include: -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour - -## Code of Conduct - -All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). - -## License - -By contributing, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)). diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..ac78cd3 --- /dev/null +++ b/README.adoc @@ -0,0 +1,123 @@ +https://github.com/sponsors/hyperpolymath[image:https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github[Sponsor]] + +== What Is This? + +Anvomidaviser converts *ISU (International Skating Union) notation* into +formal figure skating programs via *Anvomidav* — the first programming +language for figure skating choreography. + +The pipeline: ISU notation → formal choreography models → scoring +validation → program component analysis. + +Anvomidaviser bridges existing notation systems (ISU element codes, IJS +protocols, Code of Points tables) to formally verified Anvomidav +programs. + +== How It Works + +Describe your program in `+anvomidaviser.toml+` or import ISU protocols. +Anvomidaviser: + +[arabic] +. *Parses* ISU element codes — jumps (`+3Lz+`, `+4T+3T+`), spins +(`+CCoSp4+`), steps (`+StSq3+`), lifts +. *Validates* against ISU technical rules — Zayak rule, element counts, +well-balanced requirements +. *Scores* using the Code of Points — base values, GOE adjustments, PCS, +deductions +. *Generates* formal Anvomidav programs with timing, transitions, and +rink positions +. *Outputs* score sheets, validation reports, and choreography files + +== Use Cases + +* *Competition program planning* — build programs, check legality, +estimate scores before training +* *Judging consistency checks* — verify scores against ISU rules +programmatically +* *Training feedback* — track element difficulty progression across +seasons +* *Coaching tools* — visualise program layout, timing, and transitions + +== Architecture + +Follows the hyperpolymath -iser pattern: + +.... +anvomidaviser.toml (manifest) + | + v + ISU Parser (Rust CLI) + | + v + Idris2 ABI (proves scoring rule correctness) + | + v + Zig FFI (C-ABI bridge to scoring engine) + | + v + Anvomidav Codegen (formal program descriptions) +.... + +Part of the https://github.com/hyperpolymath/iseriser[-iser family]. + +== CLI Commands + +[source,bash] +---- +# Create a new manifest +anvomidaviser init + +# Validate a manifest against ISU rules +anvomidaviser validate -m anvomidaviser.toml + +# Generate Anvomidav program and score sheets +anvomidaviser generate -m anvomidaviser.toml -o generated/ + +# Build generated artifacts +anvomidaviser build -m anvomidaviser.toml --release + +# Run the scoring engine +anvomidaviser run -m anvomidaviser.toml + +# Show manifest information +anvomidaviser info -m anvomidaviser.toml +---- + +== Example Manifest + +[source,toml] +---- +[workload] +name = "ladies-short-2026" +discipline = "ladies-single" +segment = "short-program" + +[elements] +jump_1 = "3Lz+3T" +spin_1 = "FCSp4" +step_seq = "StSq4" +jump_2 = "3F" +spin_2 = "CCoSp4" +jump_3 = "2A" +spin_3 = "LSp4" + +[program] +music = "Clair de Lune" +duration_seconds = 160 + +[output] +format = "anvomidav" +score_sheet = true +validation_report = true +---- + +== Status + +*Pre-alpha / Codebase in progress.* Architecture defined, CLI +scaffolded, bespoke Idris2 ABI types for ISU scoring, Zig FFI stubs with +anvomidaviser symbols. Codegen and scoring engine pending. + +== License + +SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/README.md b/README.md deleted file mode 100644 index 61ae1df..0000000 --- a/README.md +++ /dev/null @@ -1,130 +0,0 @@ - - -[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath) - -# What Is This? - -Anvomidaviser converts **ISU (International Skating Union) notation** -into formal figure skating programs via **Anvomidav** — the first -programming language for figure skating choreography. - -The pipeline: ISU notation → formal choreography models → scoring -validation → program component analysis. - -Anvomidaviser bridges existing notation systems (ISU element codes, IJS -protocols, Code of Points tables) to formally verified Anvomidav -programs. - -# How It Works - -Describe your program in `anvomidaviser.toml` or import ISU protocols. -Anvomidaviser: - -1. **Parses** ISU element codes — jumps (`3Lz`, `4T+3T`), spins - (`CCoSp4`), steps (`StSq3`), lifts - -2. **Validates** against ISU technical rules — Zayak rule, element - counts, well-balanced requirements - -3. **Scores** using the Code of Points — base values, GOE adjustments, - PCS, deductions - -4. **Generates** formal Anvomidav programs with timing, transitions, - and rink positions - -5. **Outputs** score sheets, validation reports, and choreography files - -# Use Cases - -- **Competition program planning** — build programs, check legality, - estimate scores before training - -- **Judging consistency checks** — verify scores against ISU rules - programmatically - -- **Training feedback** — track element difficulty progression across - seasons - -- **Coaching tools** — visualise program layout, timing, and transitions - -# Architecture - -Follows the hyperpolymath -iser pattern: - - anvomidaviser.toml (manifest) - | - v - ISU Parser (Rust CLI) - | - v - Idris2 ABI (proves scoring rule correctness) - | - v - Zig FFI (C-ABI bridge to scoring engine) - | - v - Anvomidav Codegen (formal program descriptions) - -Part of the [-iser family](https://github.com/hyperpolymath/iseriser). - -# CLI Commands - -```bash -# Create a new manifest -anvomidaviser init - -# Validate a manifest against ISU rules -anvomidaviser validate -m anvomidaviser.toml - -# Generate Anvomidav program and score sheets -anvomidaviser generate -m anvomidaviser.toml -o generated/ - -# Build generated artifacts -anvomidaviser build -m anvomidaviser.toml --release - -# Run the scoring engine -anvomidaviser run -m anvomidaviser.toml - -# Show manifest information -anvomidaviser info -m anvomidaviser.toml -``` - -# Example Manifest - -```toml -[workload] -name = "ladies-short-2026" -discipline = "ladies-single" -segment = "short-program" - -[elements] -jump_1 = "3Lz+3T" -spin_1 = "FCSp4" -step_seq = "StSq4" -jump_2 = "3F" -spin_2 = "CCoSp4" -jump_3 = "2A" -spin_3 = "LSp4" - -[program] -music = "Clair de Lune" -duration_seconds = 160 - -[output] -format = "anvomidav" -score_sheet = true -validation_report = true -``` - -# Status - -**Pre-alpha / Codebase in progress.** Architecture defined, CLI -scaffolded, bespoke Idris2 ABI types for ISU scoring, Zig FFI stubs with -anvomidaviser symbols. Codegen and scoring engine pending. - -# License - -SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/REQUIRES_INITIALISATION.adoc b/REQUIRES_INITIALISATION.adoc new file mode 100644 index 0000000..c793345 --- /dev/null +++ b/REQUIRES_INITIALISATION.adoc @@ -0,0 +1,120 @@ +== REQUIRES INITIALISATION + +*This repository is not finished being set up.* 9 substitution token(s) +across 3 file(s) still have no value. + +=== Why this is not already done + +This repo was created from `+hyperpolymath/rsr-template-repo+`. The mint +(`+just repo-init+`) fills every token that has a single mechanical +answer — owner, repo, author, dates, licence, branch — and it has done +so here. + +The tokens below are the ones it _deliberately cannot_ answer. They need +a decision or a fact that exists only in your head: what this project is +for, what command builds it, which port the service listens on, whether +a PGP key is held at all. The template’s own token vocabulary says as +much — you cannot sensibly answer "`required invariants`" in a +thirty-second bootstrap. + +They were left *visibly unfilled on purpose*. The alternatives were both +worse: inventing plausible values would put confident falsehoods into a +security policy and an architecture document, and silently deleting the +sections would hide the fact that a decision is owed. A visible gap is +honest; a fabricated answer is not. + +=== Do not delete this file until every item below is resolved + +This file is the only marker that the work is outstanding. Deleting it +early does not finish the setup, it just conceals it — and the next +person or agent to arrive will reasonably assume the repo is complete. + +* *If you are a person:* delete this file yourself once the last item is +done. +* *If you are an agent:* resolve what you legitimately can, leave the +rest, and delete this file only when no token below remains anywhere in +the tree. Do not delete it to make a gate go green. + +Re-running the estate top-up tool will remove this file automatically +once nothing is outstanding, so the safest way to finish is to fix the +tokens and let the check confirm it. + +=== What is needed, and where it goes + +==== `+{{ARGS}}+` + +Arguments for the justfile recipe this appears in. + +Appears in: + +* `+Justfile+` + +==== `+{{CONSUMER1}}+` + +A downstream repo that consumes this one. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{CONSUMER2}}+` + +A second downstream consumer. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{DEP1}}+` + +First named dependency, in .machine_readable/INTENT.contractile. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{DEP2}}+` + +Second named dependency, in .machine_readable/INTENT.contractile. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{MONOREPO_OR_STANDALONE}}+` + +Literally '`monorepo`' or '`standalone`'. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{ONE_PARAGRAPH_ANTI_PURPOSE}}+` + +A paragraph on what this deliberately is NOT for. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{ONE_PARAGRAPH_PURPOSE}}+` + +A paragraph on what this is for. + +Appears in: + +* `+.machine_readable/INTENT.contractile+` + +==== `+{{PROJECT_UNIQUE_STRENGTH}}+` + +What this does that its alternatives do not. + +Appears in: + +* `+.machine_readable/agent_instructions/methodology.a2ml+` + +''''' + +Generated by the estate top-up pass. Rationale and the governing rulings +are in `+hyperpolymath/standards+`; the token vocabulary is +`+.machine_readable/ai/PLACEHOLDERS.adoc+` in `+rsr-template-repo+`. diff --git a/REQUIRES_INITIALISATION.md b/REQUIRES_INITIALISATION.md deleted file mode 100644 index fc1d605..0000000 --- a/REQUIRES_INITIALISATION.md +++ /dev/null @@ -1,118 +0,0 @@ - - -# REQUIRES INITIALISATION - -**This repository is not finished being set up.** 9 substitution token(s) across 3 file(s) still have no value. - -## Why this is not already done - -This repo was created from `hyperpolymath/rsr-template-repo`. The mint -(`just repo-init`) fills every token that has a single mechanical answer — -owner, repo, author, dates, licence, branch — and it has done so here. - -The tokens below are the ones it *deliberately cannot* answer. They need a -decision or a fact that exists only in your head: what this project is for, -what command builds it, which port the service listens on, whether a PGP key -is held at all. The template's own token vocabulary says as much — you cannot -sensibly answer "required invariants" in a thirty-second bootstrap. - -They were left **visibly unfilled on purpose**. The alternatives were both -worse: inventing plausible values would put confident falsehoods into a -security policy and an architecture document, and silently deleting the -sections would hide the fact that a decision is owed. A visible gap is -honest; a fabricated answer is not. - -## Do not delete this file until every item below is resolved - -This file is the only marker that the work is outstanding. Deleting it early -does not finish the setup, it just conceals it — and the next person or agent -to arrive will reasonably assume the repo is complete. - -- **If you are a person:** delete this file yourself once the last item is done. -- **If you are an agent:** resolve what you legitimately can, leave the rest, - and delete this file only when no token below remains anywhere in the tree. - Do not delete it to make a gate go green. - -Re-running the estate top-up tool will remove this file automatically once -nothing is outstanding, so the safest way to finish is to fix the tokens and -let the check confirm it. - -## What is needed, and where it goes - -### `{{ARGS}}` - -Arguments for the justfile recipe this appears in. - -Appears in: - -- `Justfile` - -### `{{CONSUMER1}}` - -A downstream repo that consumes this one. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{CONSUMER2}}` - -A second downstream consumer. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{DEP1}}` - -First named dependency, in .machine_readable/INTENT.contractile. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{DEP2}}` - -Second named dependency, in .machine_readable/INTENT.contractile. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{MONOREPO_OR_STANDALONE}}` - -Literally 'monorepo' or 'standalone'. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{ONE_PARAGRAPH_ANTI_PURPOSE}}` - -A paragraph on what this deliberately is NOT for. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{ONE_PARAGRAPH_PURPOSE}}` - -A paragraph on what this is for. - -Appears in: - -- `.machine_readable/INTENT.contractile` - -### `{{PROJECT_UNIQUE_STRENGTH}}` - -What this does that its alternatives do not. - -Appears in: - -- `.machine_readable/agent_instructions/methodology.a2ml` - ---- - -Generated by the estate top-up pass. Rationale and the governing rulings are -in `hyperpolymath/standards`; the token vocabulary is -`.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`. diff --git a/SECURITY.adoc b/SECURITY.adoc new file mode 100644 index 0000000..d5d6dee --- /dev/null +++ b/SECURITY.adoc @@ -0,0 +1,25 @@ +== Security Policy + +=== Supported Versions + +[cols=",",options="header",] +|=== +|Version |Supported +|0.1.x |✅ +|=== + +=== Reporting a Vulnerability + +Please report security vulnerabilities to: j.d.a.jewell@open.ac.uk + +Do NOT open a public issue for security vulnerabilities. + +=== Response Time + +We aim to respond within 48 hours and provide a fix within 7 days for +critical issues. + +=== Scope + +This policy covers the anvomidaviser CLI tool and its generated +artifacts. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index b69ae0f..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,21 +0,0 @@ -# Security Policy - -## Supported Versions - -| Version | Supported | -|---------|-----------| -| 0.1.x | ✅ | - -## Reporting a Vulnerability - -Please report security vulnerabilities to: j.d.a.jewell@open.ac.uk - -Do NOT open a public issue for security vulnerabilities. - -## Response Time - -We aim to respond within 48 hours and provide a fix within 7 days for critical issues. - -## Scope - -This policy covers the anvomidaviser CLI tool and its generated artifacts. diff --git a/TEST-NEEDS.adoc b/TEST-NEEDS.adoc new file mode 100644 index 0000000..99a8b7e --- /dev/null +++ b/TEST-NEEDS.adoc @@ -0,0 +1,34 @@ +== TEST-NEEDS.md — anvomidaviser + +=== CRG Grade: C — ACHIEVED 2026-04-04 + +=== Current Test State + +[cols=",,",options="header",] +|=== +|Category |Count |Notes +|Test directories |2 |Location(s): /tests, /verification/tests +|CI workflows |22 |Running tests on GitHub Actions +|Unit tests |Built-in |Rust/cargo test framework +|Integration tests |Configured |Via integration/ directory +|=== + +=== What’s Covered + +* [x] Rust unit test suite (cargo test) +* [x] Documentation tests +* [x] Example programs with tests + +=== Still Missing (for CRG B+) + +* [ ] Code coverage reports (codecov integration) +* [ ] Detailed test documentation in CONTRIBUTING.md +* [ ] Integration tests beyond unit tests +* [ ] Performance benchmarking suite + +=== Run Tests + +[source,bash] +---- +cargo test +---- diff --git a/TEST-NEEDS.md b/TEST-NEEDS.md deleted file mode 100644 index 0ba4f69..0000000 --- a/TEST-NEEDS.md +++ /dev/null @@ -1,31 +0,0 @@ -# TEST-NEEDS.md — anvomidaviser - -## CRG Grade: C — ACHIEVED 2026-04-04 - -## Current Test State - -| Category | Count | Notes | -|----------|-------|-------| -| Test directories | 2 | Location(s): /tests, /verification/tests | -| CI workflows | 22 | Running tests on GitHub Actions | -| Unit tests | Built-in | Rust/cargo test framework | -| Integration tests | Configured | Via integration/ directory | - -## What's Covered - -- [x] Rust unit test suite (cargo test) -- [x] Documentation tests -- [x] Example programs with tests - -## Still Missing (for CRG B+) - -- [ ] Code coverage reports (codecov integration) -- [ ] Detailed test documentation in CONTRIBUTING.md -- [ ] Integration tests beyond unit tests -- [ ] Performance benchmarking suite - -## Run Tests - -```bash -cargo test -``` diff --git a/TOPOLOGY.md b/TOPOLOGY.adoc similarity index 88% rename from TOPOLOGY.md rename to TOPOLOGY.adoc index 148cf46..f0b58ed 100644 --- a/TOPOLOGY.md +++ b/TOPOLOGY.adoc @@ -1,14 +1,13 @@ - -# anvomidaviser — Repository Topology +== anvomidaviser — Repository Topology -## Overview +=== Overview -ISU notation to formal Anvomidav choreography engine. -Part of the hyperpolymath -iser family (https://github.com/hyperpolymath/iseriser). +ISU notation to formal Anvomidav choreography engine. Part of the +hyperpolymath -iser family (https://github.com/hyperpolymath/iseriser). -## Directory Map +=== Directory Map -``` +.... anvomidaviser/ ├── 0-AI-MANIFEST.a2ml # AI agent entry point (read first) ├── Cargo.toml # Rust project manifest @@ -81,11 +80,11 @@ anvomidaviser/ │ └── .github/ # GitHub community metadata + workflows └── workflows/ # 17 CI/CD workflows -``` +.... -## Data Flow +=== Data Flow -``` +.... anvomidaviser.toml (manifest) │ ▼ @@ -116,15 +115,17 @@ anvomidaviser.toml (manifest) │ ▼ Output: .anvomidav files, score sheets, validation reports -``` +.... -## Key Integration Points +=== Key Integration Points -| System | Role | -|--------|------| -| **iseriser** | Meta-framework that generated this scaffold | -| **proven** | Shared Idris2 verified library for common proofs | -| **typell** | Type theory engine used by ABI layer | -| **boj-server** | MCP cartridge host for remote scoring access | -| **verisimdb** | Historical competition data storage | -| **panll** | Visual panel for program planning UI | +[cols=",",options="header",] +|=== +|System |Role +|*iseriser* |Meta-framework that generated this scaffold +|*proven* |Shared Idris2 verified library for common proofs +|*typell* |Type theory engine used by ABI layer +|*boj-server* |MCP cartridge host for remote scoring access +|*verisimdb* |Historical competition data storage +|*panll* |Visual panel for program planning UI +|=== diff --git a/llm-warmup-dev.adoc b/llm-warmup-dev.adoc new file mode 100644 index 0000000..f35d8d0 --- /dev/null +++ b/llm-warmup-dev.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — anvomidaviser (Developer) + +=== What is anvomidaviser? + +See README.adoc for overview. + +=== Key Commands + +* `+just setup+` — set up development environment +* `+just build+` — build the project +* `+just test+` — run tests +* `+just doctor+` — diagnose issues +* `+just heal+` — attempt auto-repair + +=== Quick Context + +* License: MPL-2.0 +* Part of hyperpolymath ecosystem +* See EXPLAINME.adoc for architecture diff --git a/llm-warmup-dev.md b/llm-warmup-dev.md deleted file mode 100644 index cc328cd..0000000 --- a/llm-warmup-dev.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — anvomidaviser (Developer) - -## What is anvomidaviser? -See README.adoc for overview. - -## Key Commands -- `just setup` — set up development environment -- `just build` — build the project -- `just test` — run tests -- `just doctor` — diagnose issues -- `just heal` — attempt auto-repair - -## Quick Context -- License: MPL-2.0 -- Part of hyperpolymath ecosystem -- See EXPLAINME.adoc for architecture diff --git a/llm-warmup-user.adoc b/llm-warmup-user.adoc new file mode 100644 index 0000000..cd6710a --- /dev/null +++ b/llm-warmup-user.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — anvomidaviser (User) + +=== What is anvomidaviser? + +See README.adoc for overview. + +=== Key Commands + +* `+just setup+` — set up development environment +* `+just build+` — build the project +* `+just test+` — run tests +* `+just doctor+` — diagnose issues +* `+just heal+` — attempt auto-repair + +=== Quick Context + +* License: MPL-2.0 +* Part of hyperpolymath ecosystem +* See EXPLAINME.adoc for architecture diff --git a/llm-warmup-user.md b/llm-warmup-user.md deleted file mode 100644 index 25c6b55..0000000 --- a/llm-warmup-user.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — anvomidaviser (User) - -## What is anvomidaviser? -See README.adoc for overview. - -## Key Commands -- `just setup` — set up development environment -- `just build` — build the project -- `just test` — run tests -- `just doctor` — diagnose issues -- `just heal` — attempt auto-repair - -## Quick Context -- License: MPL-2.0 -- Part of hyperpolymath ecosystem -- See EXPLAINME.adoc for architecture