Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions .machine_readable/READINESS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
== affinescript-vite Component Readiness Assessment

*Standard:*
https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades[Component
Readiness Grades (CRG) v2.2] *Current Grade:* C *Assessed:* 2026-04-06
*Assessor:* Jonathan D.A. Jewell

'''''

=== Summary

[width="100%",cols="25%,8%,17%,50%",options="header",]
|===
|Component |Grade |Release Stage |Evidence Summary
|Primary component |C |Alpha-stable |Dogfooded on own project; CI
passing
|===

*Overall:* Grade C — dogfooding confirmed, CI passing, deep annotation
in place.

'''''

=== Grade C Evidence

* Deployed and dogfooded on the affinescript-vite project itself
* CI passing (dogfood-gate, hypatia-scan, static-analysis-gate)
* TEST-NEEDS.md documents test matrix
* No home failures
* Deep code and folder annotation in place per CRG v2 requirements

'''''

=== Promotion Path to Grade B

Grade B requires: *6+ diverse external targets tested, issues fed back*.

Diversity means: different languages, different architectures, different
use cases.

To reach B: 1. Deploy on at least 6 external projects that differ
meaningfully from each other 2. Confirm it works in each (or document
failures) 3. Feed back any issues found (GitHub issues or PRs) 4. Update
this file with the evidence

'''''

=== Concerns and Maintenance Notes

_Document any known limitations, demotion risks, or maintenance concerns
here._

'''''

=== Run `+just crg-badge+` to generate the shields.io badge for your README.
53 changes: 0 additions & 53 deletions .machine_readable/READINESS.md

This file was deleted.

36 changes: 36 additions & 0 deletions .machine_readable/TOPOLOGY.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
== Architecture Topology

=== System Overview

RSR (Rhodium Standard Repository) template provides the canonical
scaffold for all hyperpolymath projects, with integrated CI/CD,
documentation, and service discovery patterns.

=== Component Overview

[width="100%",cols="37%,33%,30%",options="header",]
|===
|Component |Language |Purpose
|dogfood-gate workflow |YAML |Quality checks (CRG, security, linting)
|eclexiaiser-validate job |YAML |Resource cost awareness scoring
|Groove discovery |JSON |Service endpoint registration
|===

=== Data Flow

....
[Code Push] → [GitHub Actions] → [hypatia scan] → [eclexiaiser validate] → [Results]
....

=== Integration Points

* *Upstream*: Hypatia (neurosymbolic CI/CD), eclexiaiser (resource
scoring)
* *Downstream*: All RSR-based repositories (500+ instances)

=== Deployment

* Container: Stapeln Six ecosystem
* CI/CD: GitHub Actions → Hypatia scan → eclexiaiser-validate (6
scorecard dimensions) → Mirror
* Service Discovery: Groove protocol (.well-known/groove/manifest.json)
33 changes: 0 additions & 33 deletions .machine_readable/TOPOLOGY.md

This file was deleted.

135 changes: 135 additions & 0 deletions .machine_readable/compliance/PROOF-NEEDS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
== Proof Requirements — \{\{PROJECT}}

=== Proof Tier

*Tier*: T3 — Standard

=== Proof Categories

[width="100%",cols="24%,36%,40%",options="header",]
|===
|Code |Meaning |Applies?
|*TP* |Typing Proofs (type soundness, type safety) |Yes

|*INV* |Invariant Proofs (state machines, monotonicity, bounds) |

|*SEC* |Security Proofs (crypto, injection freedom, access control) |

|*CONC* |Concurrency Proofs (linearizability, deadlock freedom) |

|*ALG* |Algorithm Proofs (termination, correctness, bounds) |

|*ABI* |ABI/FFI Proofs (memory layout, pointer safety, platform compat)
|Yes

|*DOM* |Domain-Specific Proofs (bespoke to this project) |
|===

=== Mandatory Proofs (All RSR Repos)

These proofs come from the rsr-template-repo and MUST be present in
every repo:

==== ABI/FFI Boundary Proofs (Idris2)

[width="100%",cols="13%,29%,33%,25%",options="header",]
|===
|# |Proof |Status |File
|ABI-1 |Non-null pointer proofs (`+So (ptr /= 0)+`) |Needed
|`+verification/proofs/idris2/ABI/Pointers.idr+`

|ABI-2 |Memory layout correctness (`+HasSize+`, `+HasAlignment+`)
|Needed |`+verification/proofs/idris2/ABI/Layout.idr+`

|ABI-3 |Platform type size proofs (per platform) |Needed
|`+verification/proofs/idris2/ABI/Platform.idr+`

|ABI-4 |FFI function return type proofs |Needed
|`+verification/proofs/idris2/ABI/Foreign.idr+`

|ABI-5 |C ABI compliance (`+CABICompliant+`, `+FieldsAligned+`) |Needed
|`+verification/proofs/idris2/ABI/Compliance.idr+`
|===

==== Typing Proofs (Prover Varies)

[width="100%",cols="13%,29%,33%,25%",options="header",]
|===
|# |Proof |Status |File
|TP-1 |Core data type well-formedness |Needed
|`+verification/proofs/idris2/Types.idr+`

|TP-2 |Public API type safety (exported functions) |Needed
|`+verification/proofs/lean4/ApiTypes.lean+`
|===

=== Project-Specific Proofs

[cols=",,,,,",options="header",]
|===
|# |Proof Needed |Category |Prover |Priority |File(s)
| | | | | |
|===

=== Dangerous Patterns (BANNED)

The following MUST NOT appear anywhere in proof files:

[cols=",,",options="header",]
|===
|Pattern |Language |Meaning
|`+believe_me+` |Idris2 |Unsafe cast / trust-me
|`+assert_total+` |Idris2 |Skip totality check
|`+postulate+` |Idris2/Agda |Unproven axiom
|`+sorry+` |Lean4 |Incomplete proof
|`+Admitted+` |Coq |Incomplete proof
|`+unsafeCoerce+` |Haskell |Unsafe type cast
|`+Obj.magic+` |OCaml/ReScript |Unsafe type cast
|`+unsafe+` (unaudited) |Rust |Unsafe block without safety comment
|===

CI will reject any PR introducing these patterns (enforced by
`+panic-attack assail+`).

=== Prover Selection Guide

[width="100%",cols="31%,55%,14%",options="header",]
|===
|Use Case |Recommended Prover |Why
|ABI/FFI boundaries |*Idris2* |Dependent types model layouts precisely

|Type system proofs |*Coq* or *Lean4* |Mature proof assistants for
metatheory

|Algebraic properties |*Lean4* |Good mathlib support

|Inductive/coinductive |*Agda* |Native support for (co)induction

|Distributed systems |*TLA+* |Model checking for protocols

|Numerical properties |*Isabelle* |Strong real analysis library
|===

=== Proof File Locations

....
verification/proofs/
├── idris2/ # Idris2 proofs (ABI, dependent types)
│ ├── ABI/ # ABI-specific proofs
│ └── *.idr # Project-specific Idris2 proofs
├── lean4/ # Lean4 proofs (algebra, lattices)
│ └── *.lean
├── agda/ # Agda proofs (induction, metatheory)
│ └── *.agda
├── coq/ # Coq proofs (type systems, compilation)
│ └── *.v
└── tlaplus/ # TLA+ specs (distributed protocols)
└── *.tla
....

=== References

* Master list: `+~/Desktop/PROOF-REQUIREMENTS-MASTER.md+`
* Proof status tracking: `+PROOF-STATUS.md+` (this repo)
* Proven library: `+proven+` repo (Idris2 verified foundations)
* Template: `+rsr-template-repo/PROOF-NEEDS.md+`
Loading
Loading