From d9fe4e0849cf0c63e20b006902738e7edc3bb964 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Mon, 24 Aug 2026 07:54:56 +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 | 140 ++++++++++++++++++++++++++++++ README.md | 160 ----------------------------------- SECURITY.md => SECURITY.adoc | 21 +++-- TEST-NEEDS.adoc | 34 ++++++++ TEST-NEEDS.md | 31 ------- TOPOLOGY.md => TOPOLOGY.adoc | 66 ++++++++------- llm-warmup-dev.adoc | 19 +++++ llm-warmup-dev.md | 16 ---- llm-warmup-user.adoc | 19 +++++ llm-warmup-user.md | 16 ---- 14 files changed, 353 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 (57%) create mode 100644 TEST-NEEDS.adoc delete mode 100644 TEST-NEEDS.md rename TOPOLOGY.md => TOPOLOGY.adoc (79%) 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..0452a86 --- /dev/null +++ b/README.adoc @@ -0,0 +1,140 @@ +https://github.com/sponsors/hyperpolymath[image:https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github[Sponsor]] + +== What Is This? + +ATSiser analyses C source code, identifies memory-critical patterns +(malloc/free pairs, buffer accesses, pointer arithmetic, struct +ownership), and generates *ATS2 wrappers* with linear type annotations +that enforce memory safety at compile time — then compiles those +wrappers back to C with zero runtime overhead. + +https://www.cs.bu.edu/~hwxi/atslangweb/[ATS] (Applied Type System) by +Hongwei Xi at Boston University provides linear types, dependent types, +and theorem proving while compiling to C. ATSiser uses ATS2’s +`+viewtype+` and `+dataviewtype+` constructs to express pointer +ownership, array bounds, and proof obligations over existing C +interfaces — *without rewriting the original C code*. + +== How It Works + +Describe your C interface in `+atsiser.toml+`. ATSiser: + +[arabic] +. *Parses C headers* — identifies allocation sites, pointer ownership +patterns, buffer accesses, and struct field layouts +. *Generates ATS2 wrappers* — creates `+viewtype+` annotations for +pointer ownership, `+arrayview+` proofs for buffer bounds, and +`+dataviewtype+` encodings for resource lifecycles +. *Emits proof obligations* — generates ATS2 proof terms (`+praxi+`, +`+prfun+`) that the ATS2 compiler checks at compile time +. *Compiles to C* — ATS2 erases all proofs during compilation, producing +C code with identical performance to the original +. *Bridges via Zig FFI* — integration layer for non-C consumers + +=== Example Manifest + +[source,toml] +---- +[workload] +name = "my-legacy-lib" +description = "Harden libfoo with linear type safety" + +[source] +headers = ["include/foo.h", "include/bar.h"] +sources = ["src/*.c"] + +[analysis] +track-allocations = true # Follow malloc/free pairs +track-buffers = true # Bound-check array accesses +track-ownership = true # Prove pointer ownership transfer + +[output] +ats2-wrappers = "generated/ats2/" +c-headers = "generated/abi/" +proofs = "generated/proofs/" +---- + +== Key Value + +* *Memory safety for legacy C* — no rewrites, no new runtime, no garbage +collector +* *Zero runtime overhead* — ATS2 proofs are erased at compile time; +generated C is identical in performance to handwritten C +* *Gradual adoption* — wrap critical functions first, expand coverage +over time +* *Formal guarantees* — no leaks, no use-after-free, no double-free, no +out-of-bounds access — all proven at compile time via linear types + +== Architecture + +Follows the hyperpolymath -iser pattern: + +* *Manifest* (`+atsiser.toml+`) — describe WHAT C code you want hardened +* *C Source Analysis* (`+src/core/+`) — parse headers, identify +allocation patterns, track pointer ownership through call graphs +* *Idris2 ABI* (`+src/interface/abi/+`) — formal proofs that the +generated wrappers correctly model memory safety properties (ownership +transfer, buffer bounds, allocation/deallocation pairing) +* *Zig FFI* (`+src/interface/ffi/+`) — C-ABI bridge for integration with +non-C consumers +* *ATS2 Codegen* (`+src/codegen/+`) — generates ATS2 source with +`+viewtype+`, `+dataviewtype+`, `+praxi+`, and `+prfun+` annotations +* *Rust CLI* (`+src/main.rs+`) — orchestrates analysis, generation, and +compilation + +User writes zero ATS2 code. ATSiser generates everything from the +manifest and C source analysis. + +=== ATS2 Concepts Used + +* *viewtype* — linear types that track pointer ownership; consuming a +`+viewtype+` value proves the pointer was freed exactly once +* *dataviewtype* — algebraic data types with linear semantics for +modelling resource states (allocated, borrowed, freed) +* *arrayview* — dependent-type proofs that array accesses are within +bounds +* *praxi / prfun* — proof-level functions that establish safety +invariants without generating any runtime code + +== CLI Commands + +[source,bash] +---- +# Initialise a new manifest +atsiser init + +# Validate manifest and C sources +atsiser validate -m atsiser.toml + +# Analyse C code and generate ATS2 wrappers +atsiser generate -m atsiser.toml -o generated/atsiser + +# Build generated artifacts (ATS2 → C compilation) +atsiser build -m atsiser.toml + +# Show analysis summary +atsiser info -m atsiser.toml +---- + +== Use Cases + +* *Legacy C library hardening* — wrap libc, OpenSSL, or custom C +libraries with compile-time memory safety proofs +* *Embedded systems safety* — add formal guarantees to +resource-constrained C code without any runtime cost +* *Gradual migration from C to safe C* — incrementally wrap functions, +building a safety envelope around existing codebases +* *Compliance* — generate machine-checkable proofs of memory safety for +safety-critical or regulated codebases + +Part of the https://github.com/hyperpolymath/iseriser[-iser family] of +acceleration frameworks. + +== Status + +*Codebase in progress.* Architecture defined, CLI scaffolded, codegen +and C source analysis pending implementation. + +== License + +SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/README.md b/README.md deleted file mode 100644 index 5375740..0000000 --- a/README.md +++ /dev/null @@ -1,160 +0,0 @@ - - -[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath) - -# What Is This? - -ATSiser analyses C source code, identifies memory-critical patterns -(malloc/free pairs, buffer accesses, pointer arithmetic, struct -ownership), and generates **ATS2 wrappers** with linear type annotations -that enforce memory safety at compile time — then compiles those -wrappers back to C with zero runtime overhead. - -[ATS](https://www.cs.bu.edu/~hwxi/atslangweb/) (Applied Type System) by -Hongwei Xi at Boston University provides linear types, dependent types, -and theorem proving while compiling to C. ATSiser uses ATS2’s `viewtype` -and `dataviewtype` constructs to express pointer ownership, array -bounds, and proof obligations over existing C interfaces — **without -rewriting the original C code**. - -# How It Works - -Describe your C interface in `atsiser.toml`. ATSiser: - -1. **Parses C headers** — identifies allocation sites, pointer - ownership patterns, buffer accesses, and struct field layouts - -2. **Generates ATS2 wrappers** — creates `viewtype` annotations for - pointer ownership, `arrayview` proofs for buffer bounds, and - `dataviewtype` encodings for resource lifecycles - -3. **Emits proof obligations** — generates ATS2 proof terms (`praxi`, - `prfun`) that the ATS2 compiler checks at compile time - -4. **Compiles to C** — ATS2 erases all proofs during compilation, - producing C code with identical performance to the original - -5. **Bridges via Zig FFI** — integration layer for non-C consumers - -## Example Manifest - -```toml -[workload] -name = "my-legacy-lib" -description = "Harden libfoo with linear type safety" - -[source] -headers = ["include/foo.h", "include/bar.h"] -sources = ["src/*.c"] - -[analysis] -track-allocations = true # Follow malloc/free pairs -track-buffers = true # Bound-check array accesses -track-ownership = true # Prove pointer ownership transfer - -[output] -ats2-wrappers = "generated/ats2/" -c-headers = "generated/abi/" -proofs = "generated/proofs/" -``` - -# Key Value - -- **Memory safety for legacy C** — no rewrites, no new runtime, no - garbage collector - -- **Zero runtime overhead** — ATS2 proofs are erased at compile time; - generated C is identical in performance to handwritten C - -- **Gradual adoption** — wrap critical functions first, expand coverage - over time - -- **Formal guarantees** — no leaks, no use-after-free, no double-free, - no out-of-bounds access — all proven at compile time via linear types - -# Architecture - -Follows the hyperpolymath -iser pattern: - -- **Manifest** (`atsiser.toml`) — describe WHAT C code you want hardened - -- **C Source Analysis** (`src/core/`) — parse headers, identify - allocation patterns, track pointer ownership through call graphs - -- **Idris2 ABI** (`src/interface/abi/`) — formal proofs that the - generated wrappers correctly model memory safety properties (ownership - transfer, buffer bounds, allocation/deallocation pairing) - -- **Zig FFI** (`src/interface/ffi/`) — C-ABI bridge for integration with - non-C consumers - -- **ATS2 Codegen** (`src/codegen/`) — generates ATS2 source with - `viewtype`, `dataviewtype`, `praxi`, and `prfun` annotations - -- **Rust CLI** (`src/main.rs`) — orchestrates analysis, generation, and - compilation - -User writes zero ATS2 code. ATSiser generates everything from the -manifest and C source analysis. - -## ATS2 Concepts Used - -- **viewtype** — linear types that track pointer ownership; consuming a - `viewtype` value proves the pointer was freed exactly once - -- **dataviewtype** — algebraic data types with linear semantics for - modelling resource states (allocated, borrowed, freed) - -- **arrayview** — dependent-type proofs that array accesses are within - bounds - -- **praxi / prfun** — proof-level functions that establish safety - invariants without generating any runtime code - -# CLI Commands - -```bash -# Initialise a new manifest -atsiser init - -# Validate manifest and C sources -atsiser validate -m atsiser.toml - -# Analyse C code and generate ATS2 wrappers -atsiser generate -m atsiser.toml -o generated/atsiser - -# Build generated artifacts (ATS2 → C compilation) -atsiser build -m atsiser.toml - -# Show analysis summary -atsiser info -m atsiser.toml -``` - -# Use Cases - -- **Legacy C library hardening** — wrap libc, OpenSSL, or custom C - libraries with compile-time memory safety proofs - -- **Embedded systems safety** — add formal guarantees to - resource-constrained C code without any runtime cost - -- **Gradual migration from C to safe C** — incrementally wrap functions, - building a safety envelope around existing codebases - -- **Compliance** — generate machine-checkable proofs of memory safety - for safety-critical or regulated codebases - -Part of the [-iser family](https://github.com/hyperpolymath/iseriser) of -acceleration frameworks. - -# Status - -**Codebase in progress.** Architecture defined, CLI scaffolded, codegen -and C source analysis pending implementation. - -# License - -SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/SECURITY.md b/SECURITY.adoc similarity index 57% rename from SECURITY.md rename to SECURITY.adoc index a5ca1dc..a666775 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 atsiser CLI tool and its generated artifacts. diff --git a/TEST-NEEDS.adoc b/TEST-NEEDS.adoc new file mode 100644 index 0000000..ec81b0a --- /dev/null +++ b/TEST-NEEDS.adoc @@ -0,0 +1,34 @@ +== TEST-NEEDS.md — atsiser + +=== 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 fdc5321..0000000 --- a/TEST-NEEDS.md +++ /dev/null @@ -1,31 +0,0 @@ -# TEST-NEEDS.md — atsiser - -## 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 79% rename from TOPOLOGY.md rename to TOPOLOGY.adoc index f48510a..f715acf 100644 --- a/TOPOLOGY.md +++ b/TOPOLOGY.adoc @@ -1,17 +1,15 @@ - - -# TOPOLOGY — atsiser +== TOPOLOGY — atsiser -## Purpose +=== Purpose -ATSiser wraps C codebases in ATS2 linear types for zero-cost memory safety. -It analyses C source, identifies memory-critical patterns, generates ATS2 -wrappers with `viewtype`/`dataviewtype` annotations, and compiles them back -to C with proofs erased — zero runtime overhead. +ATSiser wraps C codebases in ATS2 linear types for zero-cost memory +safety. It analyses C source, identifies memory-critical patterns, +generates ATS2 wrappers with `+viewtype+`/`+dataviewtype+` annotations, +and compiles them back to C with proofs erased — zero runtime overhead. -## Module Map +=== Module Map -``` +.... atsiser/ ├── src/ │ ├── main.rs # CLI entry point (clap subcommands) @@ -66,11 +64,11 @@ atsiser/ ├── configs/ # git-cliff, etc. ├── scripts/ # forge, lifecycle, maintenance, verification └── compliance/ # REUSE dep5, cargo-deny -``` +.... -## Data Flow +=== Data Flow -``` +.... atsiser.toml C headers + sources │ │ ▼ ▼ @@ -97,26 +95,30 @@ atsiser.toml C headers + sources Generated C (proofs erased, zero overhead) -``` +.... -## Key Types (Idris2 ABI) +=== Key Types (Idris2 ABI) -| Type | Purpose | -|------|---------| -| `LinearPtr` | Tracked C pointer with ownership proof | -| `Viewtype` | ATS2 viewtype classification (owned, borrowed, consumed) | -| `OwnershipState` | State machine for pointer lifecycle | -| `AllocationSite` | Source location of malloc/calloc/realloc | -| `BufferBounds` | Proven array access bounds (offset, length) | -| `ProofObligation` | ATS2 proof term to be emitted | +[width="100%",cols="40%,60%",options="header",] +|=== +|Type |Purpose +|`+LinearPtr+` |Tracked C pointer with ownership proof +|`+Viewtype+` |ATS2 viewtype classification (owned, borrowed, consumed) +|`+OwnershipState+` |State machine for pointer lifecycle +|`+AllocationSite+` |Source location of malloc/calloc/realloc +|`+BufferBounds+` |Proven array access bounds (offset, length) +|`+ProofObligation+` |ATS2 proof term to be emitted +|=== -## Integration Points +=== Integration Points -| System | Role | -|--------|------| -| **iseriser** | Meta-framework that generates -iser scaffolding | -| **proven** | Shared Idris2 verified library for formal proofs | -| **typell** | Type theory engine | -| **BoJ-server** | Cartridge for on-demand C wrapping | -| **PanLL** | Visualise ownership graphs and proof coverage | -| **VeriSimDB** | Store analysis results and proof artifacts | +[cols=",",options="header",] +|=== +|System |Role +|*iseriser* |Meta-framework that generates -iser scaffolding +|*proven* |Shared Idris2 verified library for formal proofs +|*typell* |Type theory engine +|*BoJ-server* |Cartridge for on-demand C wrapping +|*PanLL* |Visualise ownership graphs and proof coverage +|*VeriSimDB* |Store analysis results and proof artifacts +|=== diff --git a/llm-warmup-dev.adoc b/llm-warmup-dev.adoc new file mode 100644 index 0000000..c4446cd --- /dev/null +++ b/llm-warmup-dev.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — atsiser (Developer) + +=== What is atsiser? + +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 b6ea3dd..0000000 --- a/llm-warmup-dev.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — atsiser (Developer) - -## What is atsiser? -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..4d642bf --- /dev/null +++ b/llm-warmup-user.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — atsiser (User) + +=== What is atsiser? + +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 8adec51..0000000 --- a/llm-warmup-user.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — atsiser (User) - -## What is atsiser? -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