Skip to content

Commit 1851f1e

Browse files
committed
docs: substantive CRG C annotation (EXPLAINME.adoc)
1 parent 5b2637c commit 1851f1e

1 file changed

Lines changed: 104 additions & 5 deletions

File tree

EXPLAINME.adoc

Lines changed: 104 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,123 @@
11
// SPDX-License-Identifier: PMPL-1.0-or-later
2+
// Copyright (c) 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
23
= SnapCreate — Show Me The Receipts
34
:toc:
5+
:toclevels: 3
46
:icons: font
57

6-
The README makes claims. This file backs them up.
8+
The README makes claims. This file backs them up with current reality and honest gaps.
9+
10+
== Claim 1: RSR Infrastructure is Complete and CI-Gated
11+
12+
[quote, README]
13+
____
14+
This repository currently contains RSR (Rhodium Standard Repository) infrastructure scaffolding
15+
and is awaiting project specification and implementation.
16+
____
17+
18+
*How it works:* The repository has the full RSR skeleton: a 17-workflow `.github/workflows/`
19+
suite (CodeQL, Hypatia neurosymbolic scan, Scorecard, TruffleHog, EditorConfig, mirror, instant-sync,
20+
guix-nix-policy, rsr-antipattern, security-policy, wellknown-enforcement, workflow-linter,
21+
npm-bun-blocker, ts-blocker, scorecard-enforcer, secret-scanner), a `justfile` with standard
22+
RSR recipes, `guix.scm`, `flake.nix`, `SECURITY.md`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`,
23+
and `stapeln.toml`. The ROADMAP.adoc confirms this: all infrastructure rows are marked "Done".
24+
This means new code added to this repo immediately inherits the full hyperpolymath governance
25+
baseline — language policy enforcement, supply-chain security, and mirror propagation — from the
26+
first commit.
27+
28+
*Honest caveat:* There is no application code yet. The project specification has not been published.
29+
The README states "Project specification will be uploaded shortly" — that statement dates from 2025
30+
and the spec has not arrived as of 2026-04. This repo is purely a governance scaffold awaiting
31+
a defined purpose. The technology stack table in the README (ReScript, Deno, Rust, Gleam) is
32+
boilerplate inherited from the RSR template, not a confirmed design decision.
33+
34+
== Claim 2: Dual-Licensed with Palimpsest Overlay
735

836
[quote, README]
937
____
10-
This repository currently contains RSR (Rhodium Standard Repository) infrastructure scaffolding and is awaiting project specification and implementation.
38+
Dual-licensed under MIT OR PMPL-1.0-or-later. Encourages (non-binding) adherence to Palimpsest
39+
License principles for consent-based digital interaction.
1140
____
1241

42+
*How it works:* `LICENSE.txt` contains dual MIT/PMPL-1.0-or-later text. This is a carry-over from
43+
the RSR template's optional dual-license configuration, which accommodates downstream consumers
44+
who need an OSI-approved license (MIT) while offering the stronger Palimpsest consent principles
45+
to those who can accept them. The `LICENSES/` directory holds the full texts of both licenses.
46+
47+
*Honest caveat:* The dual MIT/PMPL license is itself infrastructure boilerplate. Until application
48+
code exists, the license choice has no material consequence. When implementation begins, the license
49+
decision should be revisited deliberately — if there is no specific requirement for MIT
50+
compatibility, PMPL-1.0-or-later alone is the standard hyperpolymath policy.
51+
52+
== Dogfooded Across The Account
53+
54+
[cols="1,2,1"]
55+
|===
56+
| Repo | Relationship | Status
57+
58+
| `rsr-template-repo`
59+
| SnapCreate was cloned from the RSR template; it validates that the template produces a
60+
correctly-wired repo with no manual fixup required
61+
| Active (structural proof)
62+
63+
| `hypatia`
64+
| Hypatia's CI scan validates SnapCreate's workflow conformance on every push
65+
| Active
66+
67+
| `HyperpolymathRegistry`
68+
| SnapCreate is registered in the account registry; its pre-specification status is tracked
69+
| Active
70+
|===
71+
1372
== File Map
1473

15-
[cols="1,2"]
74+
[cols="1,3"]
1675
|===
1776
| Path | What's There
1877

19-
| `test(s)/` | Test suite
78+
| `README.adoc`
79+
| Project overview: pre-specification status, planned tech stack, placeholder getting-started guide
80+
81+
| `ROADMAP.adoc`
82+
| Infrastructure completion matrix + blank implementation milestones awaiting project spec
83+
84+
| `docs/CITATIONS.adoc`
85+
| Citation format for when the project publishes results or datasets
86+
87+
| `justfile`
88+
| RSR-standard recipes: `build`, `test`, `check`, `guix-shell`, `nix-shell`, `panic`
89+
90+
| `LICENSE.txt`
91+
| Dual MIT/PMPL-1.0-or-later license text
92+
93+
| `LICENSES/`
94+
| Full license texts: PMPL-1.0-or-later.txt + MPL-2.0.txt
95+
96+
| `SECURITY.md`
97+
| Security policy template (responsible disclosure process)
98+
99+
| `CONTRIBUTING.md`
100+
| Contribution guidelines template
101+
102+
| `guix.scm`
103+
| Guix package manifest (template; no project-specific packages yet)
104+
105+
| `flake.nix`
106+
| Nix flake (template; no project-specific derivations yet)
107+
108+
| `stapeln.toml`
109+
| Stapeln container configuration (template)
110+
111+
| `.github/workflows/`
112+
| 17 RSR-standard CI workflows (all present and SHA-pinned)
113+
114+
| `.machine_readable/6a2/`
115+
| A2ML machine-readable artefacts (STATE, META, ECOSYSTEM, AGENTIC, NEUROSYM, PLAYBOOK)
116+
117+
| `0-AI-MANIFEST.a2ml`
118+
| AI agent entry point: canonical file locations, critical invariants, lifecycle hooks
20119
|===
21120

22121
== Questions?
23122

24-
Open an issue or reach out directly — happy to explain anything in more detail.
123+
Open an issue or reach out to Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>.

0 commit comments

Comments
 (0)