diff --git a/ARCHITECTURE.adoc b/ARCHITECTURE.adoc new file mode 100644 index 0000000..1c0a7a6 --- /dev/null +++ b/ARCHITECTURE.adoc @@ -0,0 +1,48 @@ +== Architecture + +=== Overview + +This repository follows a modular, maintainable architecture designed +for clarity, scalability, and long-term sustainability. + +=== Directory Structure + +.... +. +├── src/ # Source code +├── tests/ # Test suites +├── docs/ # Documentation +├── scripts/ # Utility scripts +├── config/ # Configuration files +├── LICENSE # License file +├── LICENSES/ # Full license texts +└── README.adoc # Project documentation +.... + +=== Design Principles + +* *Separation of Concerns*: Each module has a single responsibility +* *Testability*: Code is written to be easily testable +* *Documentation*: All public APIs are documented +* *Configuration*: Environment-specific settings are externalized + +=== Dependencies + +* External dependencies are minimized and clearly declared +* Version pinning is used for reproducibility + +=== Security Considerations + +* Sensitive data is never committed to the repository +* Secrets are managed through environment variables or secure vaults +* Regular dependency audits are performed + +=== Maintainability + +* Code follows consistent style guidelines +* Pull requests require review and CI checks +* Issues and discussions are tracked transparently + +''''' + +_Last updated: 2026-07-18_ diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md deleted file mode 100644 index 607e3d8..0000000 --- a/ARCHITECTURE.md +++ /dev/null @@ -1,47 +0,0 @@ -# Architecture - -## Overview - -This repository follows a modular, maintainable architecture designed for clarity, scalability, and long-term sustainability. - -## Directory Structure - -``` -. -├── src/ # Source code -├── tests/ # Test suites -├── docs/ # Documentation -├── scripts/ # Utility scripts -├── config/ # Configuration files -├── LICENSE # License file -├── LICENSES/ # Full license texts -└── README.adoc # Project documentation -``` - -## Design Principles - -- **Separation of Concerns**: Each module has a single responsibility -- **Testability**: Code is written to be easily testable -- **Documentation**: All public APIs are documented -- **Configuration**: Environment-specific settings are externalized - -## Dependencies - -- External dependencies are minimized and clearly declared -- Version pinning is used for reproducibility - -## Security Considerations - -- Sensitive data is never committed to the repository -- Secrets are managed through environment variables or secure vaults -- Regular dependency audits are performed - -## Maintainability - -- Code follows consistent style guidelines -- Pull requests require review and CI checks -- Issues and discussions are tracked transparently - ---- - -*Last updated: 2026-07-18* diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc new file mode 100644 index 0000000..3f3954f --- /dev/null +++ b/CHANGELOG.adoc @@ -0,0 +1,21 @@ +== Changelog + +All notable changes to squeakwell will be documented in this file. + +The format is based on https://keepachangelog.com/en/1.1.0/[Keep a +Changelog], and this project adheres to +https://semver.org/spec/v2.0.0.html[Semantic Versioning]. + +=== [0.1.0] - 2026-03-20 + +==== Added + +* Initial project scaffold from rsr-template-repo +* CLI with subcommands (init, validate, generate, build, run, info) +* Manifest parser (`+squeakwell.toml+`) +* Codegen engine (stubs — target-language-specific implementation +pending) +* ABI module (Idris2 proof type definitions) +* Library API for programmatic use +* Full RSR template (17 CI workflows, governance docs, bot directives) +* README.adoc with architecture overview and value proposition diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 91097c3..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,18 +0,0 @@ -# Changelog - -All notable changes to squeakwell will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [0.1.0] - 2026-03-20 - -### Added -- Initial project scaffold from rsr-template-repo -- CLI with subcommands (init, validate, generate, build, run, info) -- Manifest parser (`squeakwell.toml`) -- Codegen engine (stubs — target-language-specific implementation pending) -- ABI module (Idris2 proof type definitions) -- Library API for programmatic use -- Full RSR template (17 CI workflows, governance docs, bot directives) -- README.adoc with architecture overview and value proposition 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/GOVERNANCE.adoc b/GOVERNANCE.adoc new file mode 100644 index 0000000..9b836fb --- /dev/null +++ b/GOVERNANCE.adoc @@ -0,0 +1,60 @@ +== Governance + +=== Overview + +This project is governed by the following principles and structures to +ensure transparent, inclusive, and effective decision-making. + +=== Roles and Responsibilities + +==== Maintainers + +Maintainers are responsible for: - Reviewing and merging pull requests - +Managing releases and versioning - Ensuring code quality and standards - +Triaging issues and bug reports - Community engagement and support + +==== Contributors + +Contributors are expected to: - Follow the code of conduct - Submit +well-documented pull requests - Write tests for new functionality - +Maintain existing tests - Update documentation as needed + +=== Decision Making + +==== Minor Changes + +* Can be made by any maintainer +* Include bug fixes, documentation updates, dependency updates + +==== Major Changes + +* Require discussion in issues or pull requests +* Include new features, architectural changes, API changes +* Need approval from at least 2 maintainers + +==== Breaking Changes + +* Require RFC (Request for Comments) process +* Need approval from majority of maintainers +* Must include migration guide + +=== Code of Conduct + +All participants are expected to follow our Code of Conduct. Violations +can be reported to the maintainers. + +=== Communication + +* *Issues*: For bug reports and feature requests +* *Discussions*: For questions and general discussion +* *Pull Requests*: For code contributions + +=== Licensing + +All contributions are made under the terms of the repository’s LICENSE +file. By submitting a pull request, you agree to license your +contributions accordingly. + +''''' + +_Last updated: 2026-07-18_ diff --git a/GOVERNANCE.md b/GOVERNANCE.md deleted file mode 100644 index e27364c..0000000 --- a/GOVERNANCE.md +++ /dev/null @@ -1,60 +0,0 @@ -# Governance - -## Overview - -This project is governed by the following principles and structures to ensure transparent, inclusive, and effective decision-making. - -## Roles and Responsibilities - -### Maintainers - -Maintainers are responsible for: -- Reviewing and merging pull requests -- Managing releases and versioning -- Ensuring code quality and standards -- Triaging issues and bug reports -- Community engagement and support - -### Contributors - -Contributors are expected to: -- Follow the code of conduct -- Submit well-documented pull requests -- Write tests for new functionality -- Maintain existing tests -- Update documentation as needed - -## Decision Making - -### Minor Changes -- Can be made by any maintainer -- Include bug fixes, documentation updates, dependency updates - -### Major Changes -- Require discussion in issues or pull requests -- Include new features, architectural changes, API changes -- Need approval from at least 2 maintainers - -### Breaking Changes -- Require RFC (Request for Comments) process -- Need approval from majority of maintainers -- Must include migration guide - -## Code of Conduct - -All participants are expected to follow our Code of Conduct. Violations can be reported to the maintainers. - -## Communication - -- **Issues**: For bug reports and feature requests -- **Discussions**: For questions and general discussion -- **Pull Requests**: For code contributions - -## Licensing - -All contributions are made under the terms of the repository's LICENSE file. -By submitting a pull request, you agree to license your contributions accordingly. - ---- - -*Last updated: 2026-07-18* diff --git a/PROOF-NEEDS.adoc b/PROOF-NEEDS.adoc new file mode 100644 index 0000000..c51c86c --- /dev/null +++ b/PROOF-NEEDS.adoc @@ -0,0 +1,49 @@ +== PROOF-NEEDS.md + +=== Current State + +* *LOC*: ~3,470 +* *Languages*: Rust, Idris2, Zig +* *Existing ABI proofs*: `+src/interface/abi/*.idr+` (template-level) +* *Dangerous patterns*: None detected + +=== What Needs Proving + +==== Data Recovery Engine (src/engine/) + +* Octad recovery — data reconstruction from partial records +* Prove: recovery algorithm produces correct reconstructions when +sufficient data is available +* Prove: recovery reports failure (not corrupt data) when data is +insufficient + +==== Ingestion Pipeline (src/ingest/) + +* Data ingestion and validation +* Prove: ingestion preserves data integrity (no silent corruption) + +==== Manifest Handling (src/manifest/) + +* Recovery manifest specification +* Prove: manifest accurately describes recoverable data state + +==== ABI Layer (src/abi/) + +* Rust ABI module — should be backed by Idris2 contracts + +=== Recommended Prover + +* *Idris2* for recovery correctness invariants + +=== Priority + +*MEDIUM* — Data recovery tool where incorrect recovery is worse than no +recovery. The "`never return corrupt data`" invariant is safety-critical +and should be proven. + +=== Template ABI Cleanup (2026-03-29) + +Template ABI removed – was creating false impression of formal +verification. The removed files (Types.idr, Layout.idr, Foreign.idr) +contained only RSR template scaffolding with unresolved +\{\{PROJECT}}/\{\{AUTHOR}} placeholders and no domain-specific proofs. diff --git a/PROOF-NEEDS.md b/PROOF-NEEDS.md deleted file mode 100644 index 2e9ccaf..0000000 --- a/PROOF-NEEDS.md +++ /dev/null @@ -1,41 +0,0 @@ -# PROOF-NEEDS.md - - -## Current State - -- **LOC**: ~3,470 -- **Languages**: Rust, Idris2, Zig -- **Existing ABI proofs**: `src/interface/abi/*.idr` (template-level) -- **Dangerous patterns**: None detected - -## What Needs Proving - -### Data Recovery Engine (src/engine/) -- Octad recovery — data reconstruction from partial records -- Prove: recovery algorithm produces correct reconstructions when sufficient data is available -- Prove: recovery reports failure (not corrupt data) when data is insufficient - -### Ingestion Pipeline (src/ingest/) -- Data ingestion and validation -- Prove: ingestion preserves data integrity (no silent corruption) - -### Manifest Handling (src/manifest/) -- Recovery manifest specification -- Prove: manifest accurately describes recoverable data state - -### ABI Layer (src/abi/) -- Rust ABI module — should be backed by Idris2 contracts - -## Recommended Prover - -- **Idris2** for recovery correctness invariants - -## Priority - -**MEDIUM** — Data recovery tool where incorrect recovery is worse than no recovery. The "never return corrupt data" invariant is safety-critical and should be proven. - -## Template ABI Cleanup (2026-03-29) - -Template ABI removed -- was creating false impression of formal verification. -The removed files (Types.idr, Layout.idr, Foreign.idr) contained only RSR template -scaffolding with unresolved {{PROJECT}}/{{AUTHOR}} placeholders and no domain-specific proofs. diff --git a/SECURITY.md b/SECURITY.adoc similarity index 58% rename from SECURITY.md rename to SECURITY.adoc index f169e5f..597b26e 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 squeakwell CLI tool and its generated artifacts. diff --git a/TEST-NEEDS.adoc b/TEST-NEEDS.adoc new file mode 100644 index 0000000..883cb6a --- /dev/null +++ b/TEST-NEEDS.adoc @@ -0,0 +1,57 @@ +== TEST-NEEDS: squeakwell + +=== CRG Grade: C — ACHIEVED 2026-04-04 + +=== Current State + +[width="100%",cols="40%,26%,34%",options="header",] +|=== +|Category |Count |Details +|*Source modules* |12 |Rust (main, lib, manifest/mod, engine/mod, +ingest/mod, abi/mod) + Idris2 ABI (3) + Zig FFI (3) + +|*Unit tests* |0 |Zero. No #[test] in any source file + +|*Integration tests* |0 |None + +|*E2E tests* |0 |None + +|*Benchmarks* |0 |None + +|*Fuzz tests* |0 |placeholder.txt only +|=== + +=== What’s Missing + +==== EVERYTHING (CRITICAL) + +* [ ] Zero tests of any kind for 6 Rust modules +* [ ] No test for manifest parsing +* [ ] No test for engine processing +* [ ] No test for ingest pipeline +* [ ] No test for ABI layer + +==== Aspect Tests + +* [ ] *Security*: Audio/sound processing tool with zero security tests +* [ ] *Performance*: No benchmarks for audio processing throughput +* [ ] *Concurrency*: No tests for concurrent audio stream handling +* [ ] *Error handling*: No tests for malformed audio input, codec +failures + +==== Benchmarks Needed + +* [ ] Audio processing latency +* [ ] Ingest throughput +* [ ] Memory usage under load + +==== Self-Tests + +* [ ] No self-diagnostic mode + +=== FLAGGED ISSUES + +* *12 source files, 0 tests* – completely untested +* *fuzz/placeholder.txt* – fake fuzz testing claim + +=== Priority: P0 (CRITICAL) diff --git a/TEST-NEEDS.md b/TEST-NEEDS.md deleted file mode 100644 index 2c7f823..0000000 --- a/TEST-NEEDS.md +++ /dev/null @@ -1,42 +0,0 @@ -# TEST-NEEDS: squeakwell -## CRG Grade: C — ACHIEVED 2026-04-04 - -## Current State - -| Category | Count | Details | -|----------|-------|---------| -| **Source modules** | 12 | Rust (main, lib, manifest/mod, engine/mod, ingest/mod, abi/mod) + Idris2 ABI (3) + Zig FFI (3) | -| **Unit tests** | 0 | Zero. No #[test] in any source file | -| **Integration tests** | 0 | None | -| **E2E tests** | 0 | None | -| **Benchmarks** | 0 | None | -| **Fuzz tests** | 0 | placeholder.txt only | - -## What's Missing - -### EVERYTHING (CRITICAL) -- [ ] Zero tests of any kind for 6 Rust modules -- [ ] No test for manifest parsing -- [ ] No test for engine processing -- [ ] No test for ingest pipeline -- [ ] No test for ABI layer - -### Aspect Tests -- [ ] **Security**: Audio/sound processing tool with zero security tests -- [ ] **Performance**: No benchmarks for audio processing throughput -- [ ] **Concurrency**: No tests for concurrent audio stream handling -- [ ] **Error handling**: No tests for malformed audio input, codec failures - -### Benchmarks Needed -- [ ] Audio processing latency -- [ ] Ingest throughput -- [ ] Memory usage under load - -### Self-Tests -- [ ] No self-diagnostic mode - -## FLAGGED ISSUES -- **12 source files, 0 tests** -- completely untested -- **fuzz/placeholder.txt** -- fake fuzz testing claim - -## Priority: P0 (CRITICAL) diff --git a/TOPOLOGY.md b/TOPOLOGY.adoc similarity index 54% rename from TOPOLOGY.md rename to TOPOLOGY.adoc index edf78da..0a60e8d 100644 --- a/TOPOLOGY.md +++ b/TOPOLOGY.adoc @@ -1,15 +1,17 @@ - - +== TOPOLOGY.md — squeakwell -# TOPOLOGY.md — squeakwell +=== Purpose -## Purpose +Octad-Recover (working title) is a database recovery and reconstruction +tool using VeriSimDB’s octad model and VCL-total’s progressive type +system to reassemble damaged, fragmented, or inconsistent datasets +through cross-modal constraint propagation. Enables recovery from +incomplete or corrupted data via formal verification and constraint +solving. -Octad-Recover (working title) is a database recovery and reconstruction tool using VeriSimDB's octad model and VCL-total's progressive type system to reassemble damaged, fragmented, or inconsistent datasets through cross-modal constraint propagation. Enables recovery from incomplete or corrupted data via formal verification and constraint solving. +=== Module Map -## Module Map - -``` +.... squeakwell/ ├── src/ # Rust implementation │ ├── octad/ # Octad model core @@ -19,21 +21,21 @@ squeakwell/ ├── tests/ # Comprehensive test suite ├── benches/ # Performance benchmarks └── Cargo.toml # Rust package manifest -``` +.... -## Data Flow +=== Data Flow -``` +.... [Damaged Dataset] ──► [Fragment Detection] ──► [Constraint Mapping] ──► [Octad Model] ↓ [Type Inference (VCL-total)] ──► [Reconstruction] ↓ [Verification] ──► [Recovered Data] -``` +.... -## Key Components +=== Key Components -- **Octad model**: VeriSimDB's data structure representation -- **Constraint propagation**: Cross-modal consistency enforcement -- **Type system**: VCL-total progressive types guide recovery -- **Verification**: Formal proofs of recovery correctness +* *Octad model*: VeriSimDB’s data structure representation +* *Constraint propagation*: Cross-modal consistency enforcement +* *Type system*: VCL-total progressive types guide recovery +* *Verification*: Formal proofs of recovery correctness diff --git a/llm-warmup-dev.adoc b/llm-warmup-dev.adoc new file mode 100644 index 0000000..36394fa --- /dev/null +++ b/llm-warmup-dev.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — squeakwell (Developer) + +=== What is squeakwell? + +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 70f0060..0000000 --- a/llm-warmup-dev.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — squeakwell (Developer) - -## What is squeakwell? -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..bd3f378 --- /dev/null +++ b/llm-warmup-user.adoc @@ -0,0 +1,19 @@ +== LLM Warmup — squeakwell (User) + +=== What is squeakwell? + +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 0fd9d6f..0000000 --- a/llm-warmup-user.md +++ /dev/null @@ -1,16 +0,0 @@ -# LLM Warmup — squeakwell (User) - -## What is squeakwell? -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