From d74f14385262f94e298b2084dd236516b25d84f8 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Mon, 24 Aug 2026 08:19:28 +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 | 139 ++++++++++++++++++++++++++++++ README.md | 159 ----------------------------------- SECURITY.md => SECURITY.adoc | 21 +++-- TEST-NEEDS.adoc | 45 ++++++++++ TEST-NEEDS.md | 38 --------- TOPOLOGY.md => TOPOLOGY.adoc | 58 +++++++------ llm-warmup-dev.adoc | 19 +++++ llm-warmup-dev.md | 16 ---- llm-warmup-user.adoc | 19 +++++ llm-warmup-user.md | 16 ---- 14 files changed, 361 insertions(+), 357 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 rename SECURITY.md => SECURITY.adoc (58%) create mode 100644 TEST-NEEDS.adoc delete mode 100644 TEST-NEEDS.md rename TOPOLOGY.md => TOPOLOGY.adoc (80%) 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..858f44f --- /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 `+nix 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 80ecdac..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 `nix 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..9abbce3 --- /dev/null +++ b/README.adoc @@ -0,0 +1,139 @@ +== What Is This? + +Idrisiser is the *meta-prover* of the +https://github.com/hyperpolymath/iseriser[-iser family]. It takes any +interface definition — OpenAPI specs, C header files, `+.proto+` +schemas, or bare type signatures — and generates *Idris2 dependent-type +wrappers* that _formally prove_ the interface contract is correct, then +compiles those proofs down to a native wrapper via Zig FFI. + +Idris2 is the sole formal verification language in the hyperpolymath +ecosystem (chosen over ATS2, Coq, Lean, and Agda for its dependent +types, first-class elaborator reflection, and quantitative type theory). +Idrisiser therefore sits just below `+iseriser+` itself in the -iser +hierarchy: every other -iser that needs formal guarantees routes through +Idrisiser. + +== Why Idrisiser? + +Idris2 can prove code correct at compile time, but the learning curve is +brutal. Idrisiser makes dependent-type proofs accessible to developers +who should not need a PhD in type theory: + +* *Automatic formal verification of _any_ interface* — preconditions, +postconditions, invariants, and totality are proved, not tested. +* *Impossible states become impossible* — dependent types enforce +contracts at the type level; invalid calls cannot compile. +* *Zero runtime cost* — proofs are erased at compile time; the final +native wrapper carries no proof overhead. + +== How It Works + +Describe your interface in an `+idrisiser.toml+` manifest. Idrisiser +then executes a six-stage pipeline: + +[source,text] +---- +idrisiser.toml ① + ↓ +Interface Parser <2> OpenAPI / .h / .proto / type sigs → IR + ↓ +Idris2 ABI Generation <3> Dependent types + proof obligations + ↓ +Proof Compilation <4> Totality checker, elaborator reflection + ↓ +Zig FFI Bridge <5> C-ABI native wrapper, zero overhead + ↓ +Native Wrapper <6> Statically linked, provably correct +---- + +[arabic] +. User writes only the manifest. +. Parser extracts interface contracts from heterogeneous sources. +. Generates `+Types.idr+`, `+Layout.idr+`, `+Foreign.idr+` with proof +obligations. +. Idris2 compiler verifies totality, termination, and invariant +preservation. +. Zig FFI implements C-ABI functions declared in the Idris2 ABI layer. +. Output is a native shared/static library with formally verified +behaviour. + +== Architecture + +[source,text] +---- +idrisiser/ +├── Cargo.toml # Rust CLI orchestrator +├── src/ +│ ├── main.rs # CLI entry point (init, validate, generate, build, run) +│ ├── lib.rs # Library API +│ ├── manifest/ # idrisiser.toml parser & validator +│ ├── codegen/ # Idris2 + Zig code generation +│ ├── core/ # Proof obligation engine +│ ├── definitions/ # Interface definition IR +│ ├── contracts/ # Contract extraction from parsed interfaces +│ ├── errors/ # Structured diagnostics +│ ├── bridges/ # Bridge adapters (OpenAPI, protobuf, C headers) +│ └── interface/ +│ ├── abi/ # Idris2 ABI — formal proofs (Types.idr, Layout.idr, Foreign.idr) +│ ├── ffi/ # Zig FFI — C-ABI bridge implementation +│ └── generated/ # Auto-generated C headers +├── verification/ # Property-based and proof verification harnesses +├── examples/ # End-to-end worked examples +└── docs/ # Technical documentation +---- + +=== Key Idris2 Concepts Used + +* *Dependent types* — types that depend on values, so a function’s +return type can encode its postcondition. +* *Totality checking* — the compiler proves every function terminates +and handles every input; partial functions are rejected. +* *Elaborator reflection* — Idris2 metaprogramming that generates proof +terms at compile time from the parsed interface definition. +* *Quantitative type theory (QTT)* — track how many times a value is +used; enforce linear or affine resource protocols in the generated +wrapper. + +== Use Cases + +* *Proving REST API contracts* — parse an OpenAPI spec, generate Idris2 +types that prove request/response schemas, status codes, and auth flows. +* *Safe database query wrappers* — generate wrappers that prove query +parameters are well-typed and result sets match declared schemas. +* *Protocol state machine verification* — prove that a protocol (TLS +handshake, OAuth flow) can only transition through valid states. +* *Provably-correct serialisation* — generate encoders/decoders with +proofs that round-tripping preserves data identity. +* *C header safety* — parse `+.h+` files, generate wrappers proving null +safety, bounds checking, and resource cleanup. + +== Quick Start + +[source,bash] +---- +# Initialise a manifest +idrisiser init + +# Edit idrisiser.toml to describe your interface + +# Validate the manifest +idrisiser validate + +# Generate proven-correct wrapper +idrisiser generate -o generated/my-api + +# Build native artifacts +idrisiser build --release +---- + +== Status + +*Codebase in progress.* Scaffold phase is complete (CLI, manifest +parser, ABI/FFI stubs, RSR template with full CI/CD). Interface parser +and proof generation are the active implementation frontier. See +`+ROADMAP.adoc+`. + +== License + +SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/README.md b/README.md deleted file mode 100644 index 42742db..0000000 --- a/README.md +++ /dev/null @@ -1,159 +0,0 @@ - - -# What Is This? - -Idrisiser is the **meta-prover** of the [-iser -family](https://github.com/hyperpolymath/iseriser). It takes any -interface definition — OpenAPI specs, C header files, `.proto` schemas, -or bare type signatures — and generates **Idris2 dependent-type -wrappers** that *formally prove* the interface contract is correct, then -compiles those proofs down to a native wrapper via Zig FFI. - -Idris2 is the sole formal verification language in the hyperpolymath -ecosystem (chosen over ATS2, Coq, Lean, and Agda for its dependent -types, first-class elaborator reflection, and quantitative type theory). -Idrisiser therefore sits just below `iseriser` itself in the -iser -hierarchy: every other -iser that needs formal guarantees routes through -Idrisiser. - -# Why Idrisiser? - -Idris2 can prove code correct at compile time, but the learning curve is -brutal. Idrisiser makes dependent-type proofs accessible to developers -who should not need a PhD in type theory: - -- **Automatic formal verification of *any* interface** — preconditions, - postconditions, invariants, and totality are proved, not tested. - -- **Impossible states become impossible** — dependent types enforce - contracts at the type level; invalid calls cannot compile. - -- **Zero runtime cost** — proofs are erased at compile time; the final - native wrapper carries no proof overhead. - -# How It Works - -Describe your interface in an `idrisiser.toml` manifest. Idrisiser then -executes a six-stage pipeline: - -```text -idrisiser.toml ① - ↓ -Interface Parser <2> OpenAPI / .h / .proto / type sigs → IR - ↓ -Idris2 ABI Generation <3> Dependent types + proof obligations - ↓ -Proof Compilation <4> Totality checker, elaborator reflection - ↓ -Zig FFI Bridge <5> C-ABI native wrapper, zero overhead - ↓ -Native Wrapper <6> Statically linked, provably correct -``` - -
- -1. User writes only the manifest. - -2. Parser extracts interface contracts from heterogeneous sources. - -3. Generates `Types.idr`, `Layout.idr`, `Foreign.idr` with proof - obligations. - -4. Idris2 compiler verifies totality, termination, and invariant - preservation. - -5. Zig FFI implements C-ABI functions declared in the Idris2 ABI layer. - -6. Output is a native shared/static library with formally verified - behaviour. - -
- -# Architecture - -```text -idrisiser/ -├── Cargo.toml # Rust CLI orchestrator -├── src/ -│ ├── main.rs # CLI entry point (init, validate, generate, build, run) -│ ├── lib.rs # Library API -│ ├── manifest/ # idrisiser.toml parser & validator -│ ├── codegen/ # Idris2 + Zig code generation -│ ├── core/ # Proof obligation engine -│ ├── definitions/ # Interface definition IR -│ ├── contracts/ # Contract extraction from parsed interfaces -│ ├── errors/ # Structured diagnostics -│ ├── bridges/ # Bridge adapters (OpenAPI, protobuf, C headers) -│ └── interface/ -│ ├── abi/ # Idris2 ABI — formal proofs (Types.idr, Layout.idr, Foreign.idr) -│ ├── ffi/ # Zig FFI — C-ABI bridge implementation -│ └── generated/ # Auto-generated C headers -├── verification/ # Property-based and proof verification harnesses -├── examples/ # End-to-end worked examples -└── docs/ # Technical documentation -``` - -## Key Idris2 Concepts Used - -- **Dependent types** — types that depend on values, so a function’s - return type can encode its postcondition. - -- **Totality checking** — the compiler proves every function terminates - and handles every input; partial functions are rejected. - -- **Elaborator reflection** — Idris2 metaprogramming that generates - proof terms at compile time from the parsed interface definition. - -- **Quantitative type theory (QTT)** — track how many times a value is - used; enforce linear or affine resource protocols in the generated - wrapper. - -# Use Cases - -- **Proving REST API contracts** — parse an OpenAPI spec, generate - Idris2 types that prove request/response schemas, status codes, and - auth flows. - -- **Safe database query wrappers** — generate wrappers that prove query - parameters are well-typed and result sets match declared schemas. - -- **Protocol state machine verification** — prove that a protocol (TLS - handshake, OAuth flow) can only transition through valid states. - -- **Provably-correct serialisation** — generate encoders/decoders with - proofs that round-tripping preserves data identity. - -- **C header safety** — parse `.h` files, generate wrappers proving null - safety, bounds checking, and resource cleanup. - -# Quick Start - -```bash -# Initialise a manifest -idrisiser init - -# Edit idrisiser.toml to describe your interface - -# Validate the manifest -idrisiser validate - -# Generate proven-correct wrapper -idrisiser generate -o generated/my-api - -# Build native artifacts -idrisiser build --release -``` - -# Status - -**Codebase in progress.** Scaffold phase is complete (CLI, manifest -parser, ABI/FFI stubs, RSR template with full CI/CD). Interface parser -and proof generation are the active implementation frontier. See -`ROADMAP.adoc`. - -# License - -SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/SECURITY.md b/SECURITY.adoc similarity index 58% rename from SECURITY.md rename to SECURITY.adoc index 1cbceda..7792db6 100644 --- a/SECURITY.md +++ b/SECURITY.adoc @@ -1,21 +1,24 @@ -# Security Policy +== Security Policy -## Supported Versions +=== Supported Versions -| Version | Supported | -|---------|-----------| -| 0.1.x | ✅ | +[cols=",",options="header",] +|=== +|Version |Supported +|0.1.x |✅ +|=== -## Reporting a Vulnerability +=== 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 +=== Response Time -We aim to respond within 48 hours and provide a fix within 7 days for critical issues. +We aim to respond within 48 hours and provide a fix within 7 days for +critical issues. -## Scope +=== Scope This policy covers the idrisiser CLI tool and its generated artifacts. diff --git a/TEST-NEEDS.adoc b/TEST-NEEDS.adoc new file mode 100644 index 0000000..c0494a2 --- /dev/null +++ b/TEST-NEEDS.adoc @@ -0,0 +1,45 @@ +== TEST-NEEDS.md — idrisiser + +=== CRG Grade: C — ACHIEVED 2026-04-04 + +=== Current Test State + +[cols=",,",options="header",] +|=== +|Category |Count |Notes +|Integration tests (Rust) |3 |`+tests/integration_test.rs+` +|Unit tests (Rust, `+#[test]+`) |31 |Across `+src/+` modules +|Fuzz tests |0 |`+tests/fuzz/+` directory present but empty +|=== + +=== What’s Covered + +* [x] `+manifest::init_manifest+` — creates `+idrisiser.toml+` in a temp +dir +* [x] `+manifest::load_manifest+` + `+validate+` — roundtrip against +example manifest +* [x] `+validate+` rejects empty project name +* [x] 31 unit test annotations across source modules (codegen, ABI, +etc.) + +=== CI Gate + +[source,bash] +---- +cargo test +---- + +=== Known Failures / Limitations + +* `+tests/fuzz/+` exists but contains no fuzz targets +* Integration tests depend on `+examples/user-api/idrisiser.toml+` — if +that example is removed, tests break +* No property-based tests + +=== Still Missing (for CRG B+) + +* [ ] Fuzz targets for manifest parsing +* [ ] Tests for the Idris2 codegen output (verify generated `+.idr+` +files) +* [ ] CI job independent of parent repo +* [ ] 6+ diverse external targets (CRG B requirement) diff --git a/TEST-NEEDS.md b/TEST-NEEDS.md deleted file mode 100644 index 864558b..0000000 --- a/TEST-NEEDS.md +++ /dev/null @@ -1,38 +0,0 @@ -# TEST-NEEDS.md — idrisiser - -## CRG Grade: C — ACHIEVED 2026-04-04 - -## Current Test State - -| Category | Count | Notes | -|----------|-------|-------| -| Integration tests (Rust) | 3 | `tests/integration_test.rs` | -| Unit tests (Rust, `#[test]`) | 31 | Across `src/` modules | -| Fuzz tests | 0 | `tests/fuzz/` directory present but empty | - -## What's Covered - -- [x] `manifest::init_manifest` — creates `idrisiser.toml` in a temp dir -- [x] `manifest::load_manifest` + `validate` — roundtrip against example manifest -- [x] `validate` rejects empty project name -- [x] 31 unit test annotations across source modules (codegen, ABI, etc.) - -## CI Gate - -```bash -cargo test -``` - -## Known Failures / Limitations - -- `tests/fuzz/` exists but contains no fuzz targets -- Integration tests depend on `examples/user-api/idrisiser.toml` — if that - example is removed, tests break -- No property-based tests - -## Still Missing (for CRG B+) - -- [ ] Fuzz targets for manifest parsing -- [ ] Tests for the Idris2 codegen output (verify generated `.idr` files) -- [ ] CI job independent of parent repo -- [ ] 6+ diverse external targets (CRG B requirement) diff --git a/TOPOLOGY.md b/TOPOLOGY.adoc similarity index 80% rename from TOPOLOGY.md rename to TOPOLOGY.adoc index 06d670d..09c1c30 100644 --- a/TOPOLOGY.md +++ b/TOPOLOGY.adoc @@ -1,17 +1,15 @@ - - -# TOPOLOGY.md — Idrisiser +== TOPOLOGY.md — Idrisiser -## Purpose +=== Purpose -Idrisiser is the **meta-prover** of the -iser family. It takes interface -definitions (OpenAPI, C headers, `.proto`, type signatures) and generates -Idris2 dependent-type wrappers with formal proofs of correctness, compiled -to native code via Zig FFI. +Idrisiser is the *meta-prover* of the -iser family. It takes interface +definitions (OpenAPI, C headers, `+.proto+`, type signatures) and +generates Idris2 dependent-type wrappers with formal proofs of +correctness, compiled to native code via Zig FFI. -## Module Map +=== Module Map -``` +.... idrisiser/ ├── src/ │ ├── main.rs # CLI entry (clap): init, validate, generate, build, run, info @@ -54,11 +52,11 @@ idrisiser/ ├── contractiles/ # k9, dust, lust, must, trust enforcement ├── ai/ # AI.a2ml, PLACEHOLDERS.md └── integrations/ # Tool integration configs -``` +.... -## Data Flow +=== Data Flow -``` +.... idrisiser.toml │ ┌────▼────┐ @@ -97,20 +95,28 @@ idrisiser/ │ Native │ .so / .a / .dylib / .dll │ Wrapper │ Provably correct, zero proof overhead └───────────┘ -``` +.... -## Ecosystem Position +=== Ecosystem Position -- **Above:** `iseriser` (meta-framework that scaffolds -iser repos) -- **Peers:** 28 other -iser repos (chapeliser, typedqliser, verisimiser, etc.) -- **Below:** `proven` (shared Idris2 verified library), `typell` (type theory engine) -- **Consumers:** Any -iser that needs formal verification routes through idrisiser -- **Unique role:** Only -iser that generates _proofs_, not just code +* *Above:* `+iseriser+` (meta-framework that scaffolds -iser repos) +* *Peers:* 28 other -iser repos (chapeliser, typedqliser, verisimiser, +etc.) +* *Below:* `+proven+` (shared Idris2 verified library), `+typell+` (type +theory engine) +* *Consumers:* Any -iser that needs formal verification routes through +idrisiser +* *Unique role:* Only -iser that generates _proofs_, not just code -## Key Invariants +=== Key Invariants -1. Generated Idris2 code must be **total** — no partial functions, no `sorry`, no `believe_me` -2. Proof obligations must be **complete** — every contract clause produces a proof term -3. Zig FFI must **exactly match** the Idris2 Foreign.idr declarations -4. Generated C headers must be **ABI-compatible** across Linux, macOS, Windows, WASM -5. The manifest is the **single source of truth** — all generation is deterministic +[arabic] +. Generated Idris2 code must be *total* — no partial functions, no +`+sorry+`, no `+believe_me+` +. Proof obligations must be *complete* — every contract clause produces +a proof term +. Zig FFI must *exactly match* the Idris2 Foreign.idr declarations +. Generated C headers must be *ABI-compatible* across Linux, macOS, +Windows, WASM +. The manifest is the *single source of truth* — all generation is +deterministic diff --git a/llm-warmup-dev.adoc b/llm-warmup-dev.adoc new file mode 100644 index 0000000..553d2b5 --- /dev/null +++ b/llm-warmup-dev.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — idrisiser (Developer) + +=== What is idrisiser? + +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 df4d795..0000000 --- a/llm-warmup-dev.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — idrisiser (Developer) - -## What is idrisiser? -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..c0fb663 --- /dev/null +++ b/llm-warmup-user.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — idrisiser (User) + +=== What is idrisiser? + +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 e823591..0000000 --- a/llm-warmup-user.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — idrisiser (User) - -## What is idrisiser? -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