Skip to content

Commit 8ca3f08

Browse files
hyperpolymathclaude
andcommitted
docs: correct READINESS.md grade C → X (honest assessment)
Template default of C was aspirational. Per CRG v2.0 STRICT: "honest D > dishonest B". Repo is scaffolded but has no KRL-specific content beyond template placeholders — honest grade is X. Path to E documented: grammar draft + 1 smoke test. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4490d97 commit 8ca3f08

1 file changed

Lines changed: 38 additions & 25 deletions

File tree

READINESS.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,65 @@
11
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
22
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
33

4-
# krl Component Readiness Assessment
4+
# Component Readiness — KRL
55

6-
**Standard:** [Component Readiness Grades (CRG) v2.2](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)
7-
**Current Grade:** C
6+
**Standard:** [CRG v2.0 STRICT](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)
7+
**Current Grade:** X
88
**Assessed:** 2026-04-05
99
**Assessor:** Jonathan D.A. Jewell
1010

1111
---
1212

13-
## Summary
13+
## Grade rationale (evidence for X)
1414

15-
| Component | Grade | Release Stage | Evidence Summary |
16-
|---------------------|-------|---------------|-------------------------------------------|
17-
| Primary component | C | Alpha-stable | Dogfooded on own project; CI passing |
15+
**Untested — default state.** Repository was scaffolded from rsr-template-repo
16+
on 2026-04-05. No KRL-specific content beyond the template placeholders exists yet.
1817

19-
**Overall:** Grade C — dogfooding confirmed, CI passing, deep annotation in place.
18+
Template default of "C" was overridden to X per CRG v2 STRICT honesty rule:
19+
"Grade as-is TODAY, not aspirational — honest D > dishonest B".
2020

21-
---
21+
### What exists
22+
23+
- RSR template infrastructure (workflows, SECURITY/CONTRIBUTING/CODE_OF_CONDUCT, `.machine_readable/6a2/` skeleton)
24+
- 0-AI-MANIFEST.a2ml
25+
- Template-provided directory structure
2226

23-
## Grade C Evidence
27+
### What does not yet exist
2428

25-
- Deployed and dogfooded on the krl project itself
26-
- CI passing (dogfood-gate, hypatia-scan, static-analysis-gate)
27-
- TEST-NEEDS.md documents test matrix
28-
- No home failures
29-
- Deep code and folder annotation in place per CRG v2 requirements
29+
- KRL grammar (EBNF/PEG)
30+
- Parser, AST, typechecker, compiler
31+
- Surface-syntax examples
32+
- KRL-specific test suite
33+
- Language reference documentation
3034

3135
---
3236

33-
## Promotion Path to Grade B
37+
## Path to E (pre-alpha)
38+
39+
1. Draft KRL EBNF/PEG grammar with `construct`, `transform`, `resolve`, `retrieve`
40+
operation families + compositional syntax (`;`, `|`, `close`, `let`, `find`).
41+
2. Add at least 1 test — smoke test that parses a "hello tangle" KRL source.
42+
3. Document known failures / incomplete grammar branches.
43+
44+
## Path to D (alpha)
45+
46+
After E: AST + typechecker + rudimentary compiler to TangleIR (via KRLAdapter.jl)
47+
+ test matrix across parse/typecheck/compile stages.
48+
49+
## Path to C (alpha-stable)
3450

35-
Grade B requires: **6+ diverse external targets tested, issues fed back**.
51+
After D: deep annotation, per-directory orientation, reliable dogfooding
52+
(compile several real KRL programs into stored Skein records).
3653

37-
Diversity means: different languages, different architectures, different use cases.
54+
## Path to B (beta)
3855

39-
To reach B:
40-
1. Deploy on at least 6 external projects that differ meaningfully from each other
41-
2. Confirm it works in each (or document failures)
42-
3. Feed back any issues found (GitHub issues or PRs)
43-
4. Update this file with the evidence
56+
After C: 6+ diverse external targets tested, issues fed back.
4457

4558
---
4659

47-
## Concerns and Maintenance Notes
60+
## Review cycle
4861

49-
*Document any known limitations, demotion risks, or maintenance concerns here.*
62+
Reassess on first grammar draft and on each implementation milestone.
5063

5164
---
5265

0 commit comments

Comments
 (0)