|
Important
|
This document tracks how the AffineScript repo aligns with the Rhodium Standard Repository template (RSR-template-repo, ledger entry in docs/standards/RSR-OUTLINE.adoc). RSR is an estate-wide convention, not a third-party standard; this file is the place where deviations from the template are documented and justified rather than left silent. |
| Requirement | State | Notes |
|---|---|---|
|
✅ |
Standard editor config (indent / charset). |
|
✅ |
Repo-specific ignore rules. |
|
✅ |
Task runner with all RSR-mandated recipes ( |
|
✅ |
Project overview + Getting Started. |
|
✅ |
MPL-2.0 — the legal-fallback bridge until the in-flight Palimpsest license is formally recognised. Full text and SPDX-by-file are tracked under |
|
✅ |
RFC 9116 disclosure contact. |
|
✅ |
Estate-wide AI agent affordance metadata. |
|
✅ |
Human-readable maintainer / contributor surface. |
|
Neither file currently committed; the |
|
|
✅ |
Adopted 2026-05-25 (PR #359) replacing the older |
|
❌ |
Documented exemption. This repo’s |
|
✅ |
This file. Added 2026-05-25. |
The RSR template proposes a deliberately small docs/ (only
generated/, man/, just-cookbook.adoc). This repo’s docs/ is
richer because the compiler’s documentation surface is genuinely
larger (specs + ADRs + architecture + reference + history + tutorial
+ vision). The structure is:
docs/
├── README.adoc / NAVIGATION.adoc # indices
├── ROADMAP.adoc / CAPABILITY-MATRIX.adoc / TECH-DEBT.adoc / ECOSYSTEM.adoc
├── architecture/ # compiler / backend internals
├── governance/ # licensing, security, community
├── guides/ # how-tos, programming practices
├── history/ # session notes, retired specs
├── reference/ # ABI-FFI, capabilities (technical reference)
├── reports/ # status snapshots
├── specs/ # language + typed-wasm specifications
├── standards/ # decisions, roadmap, testing, RSR-OUTLINE
├── tutorial/ # user-facing tutorials
└── vision/ # long-form direction-settingThis is a superset of the RSR-template docs/, not a contradiction —
no required RSR file is missing because of the extra subdirs.
RSR-OUTLINE §"Prohibited" lists languages estate-wide policy forbids. AffineScript-specific status:
| Prohibition | Status |
|---|---|
No Python outside |
✅ — no Python in this repo. |
No new TypeScript |
|
No CUE |
✅ — no CUE in this repo. |
No |
✅ — no |
Runtime exemptions (Node.js / Bun) |
|
# Build + test (the CI gate)
opam exec -- dune build
opam exec -- dune runtest
# Format check
opam exec -- dune build @fmt
# Migration-assistant grammar pipeline (PR #321)
just install-grammarjust validate-rsr (the RSR-template recipe name) is not currently
wired in this repo’s justfile — adding it as an alias for the
above two-line check is on the follow-up list.
-
docs/standards/RSR-OUTLINE.adoc— the upstream RSR template’s outline, vendored here so the repo can read it without leavingmain. -
.claude/CLAUDE.md— language policy + exemption tables (the authoritative source for⚠️ rows above). -
docs/CAPABILITY-MATRIX.adoc— feature-readiness matrix; this RSR-compliance file is about repo shape, that one is about language readiness. -
docs/TECH-DEBT.adoc— coordination ledger; long-form follow-up tracking for the⚠️ rows lives in DOC / CORE / INT ledger entries there.