Skip to content

Commit adaabd7

Browse files
docs: fix stale src/abi/ references (SD022) + prune merged branches (GS007) (#45)
* docs: fix stale src/abi/ references to src/interface/abi/ (SD022) The Idris2 ABI sources live in src/interface/abi/ (Types.idr, Layout.idr, Foreign.idr), but four docs still referenced the pre-rename src/abi/ path, which Hypatia's structural_drift rule (SD022) flags as a reference to a non-existent directory. Update all seven references across RSR_OUTLINE, ABI-FFI-README, MAINTENANCE-CHECKLIST and AI-CONVENTIONS, trimming diagram padding so the ASCII box/tree stay aligned. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LvsZgNxFbeqfRmrVFNhJ8G * ci(governance): bump standards pins d72fe5a -> 4ddc926 The standards estate advanced again since #42, so the governance + scorecard reusable pins went stale against the new HEAD (the staleness check compares pins to standards HEAD; this is why "Check Workflow Staleness" went red on #45, independent of its docs content). Bump both to 4ddc926. Verified against check-workflow-staleness.sh@4ddc926: same five rules, all pass (exit 0); the scorecard-reusable token appears only on the uses: line, so the #42 comment-grep bug stays fixed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LvsZgNxFbeqfRmrVFNhJ8G --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent c80d394 commit adaabd7

6 files changed

Lines changed: 9 additions & 9 deletions

File tree

.github/workflows/governance.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ permissions:
3131

3232
jobs:
3333
governance:
34-
uses: hyperpolymath/standards/.github/workflows/governance-reusable.yml@d72fe5a14e841ac6d78514b53624b6173038ee20
34+
uses: hyperpolymath/standards/.github/workflows/governance-reusable.yml@4ddc926b4b86451c2711a16bf927ed16ad2db45e

.github/workflows/scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ jobs:
2424
contents: read
2525
security-events: write
2626
id-token: write
27-
uses: hyperpolymath/standards/.github/workflows/scorecard-reusable.yml@d72fe5a14e841ac6d78514b53624b6173038ee20
27+
uses: hyperpolymath/standards/.github/workflows/scorecard-reusable.yml@4ddc926b4b86451c2711a16bf927ed16ad2db45e
2828
secrets: inherit

docs/RSR_OUTLINE.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ just validate-rsr
101101
|`AI.a2ml`
102102
|Claude-specific instructions
103103

104-
|`src/abi/`
104+
|`src/interface/abi/`
105105
|Idris2 ABI definitions (Types, Layout, Foreign)
106106

107107
|`ffi/zig/`
@@ -177,7 +177,7 @@ project/
177177
│ ├── TOPOLOGY-GUIDE.adoc
178178
│ ├── generated/
179179
│ └── man/
180-
├── src/abi/ # Idris2 ABI definitions
180+
├── src/interface/abi/ # Idris2 ABI definitions
181181
│ ├── Types.idr
182182
│ ├── Layout.idr
183183
│ └── Foreign.idr

docs/developer/ABI-FFI-README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This library follows the **Hyperpolymath RSR Standard** for ABI and FFI design:
1717
```
1818
┌─────────────────────────────────────────────┐
1919
│ ABI Definitions (Idris2) │
20-
│ src/abi/
20+
│ src/interface/abi/ │
2121
│ - Types.idr (Type definitions) │
2222
│ - Layout.idr (Memory layout proofs) │
2323
│ - Foreign.idr (FFI declarations) │
@@ -349,14 +349,14 @@ main = do
349349

350350
When modifying the ABI/FFI:
351351

352-
1. **Update ABI first** (`src/abi/*.idr`)
352+
1. **Update ABI first** (`src/interface/abi/*.idr`)
353353
- Modify type definitions
354354
- Update proofs
355355
- Ensure backward compatibility
356356

357357
2. **Generate C header**
358358
```bash
359-
idris2 --cg c-header src/abi/Types.idr -o generated/abi/game-server-admin.h
359+
idris2 --cg c-header src/interface/abi/Types.idr -o generated/abi/game-server-admin.h
360360
```
361361

362362
3. **Update FFI implementation** (`ffi/zig/src/main.zig`)

docs/governance/MAINTENANCE-CHECKLIST.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Run this pass at the end of a corrective/adaptive/perfective cycle:
104104
- single navigation entry point in root (`NAVIGATION.adoc` or equivalent)
105105
- no duplicate conflicting docs for same purpose (for example both `.md` and `.adoc` in root unless intentionally required)
106106
- [ ] Enforce ABI/FFI purity where the policy applies:
107-
- ABI definitions in Idris2 (`src/abi/*.idr`)
107+
- ABI definitions in Idris2 (`src/interface/abi/*.idr`)
108108
- FFI implementations in Zig (`ffi/**/*.zig`)
109109
- [ ] Ensure quality gate includes: formatting, lint, unit/integration tests, p2p/e2e checks, benchmark smoke, docs checks, security scan.
110110

docs/practice/AI-CONVENTIONS.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ MAINTENANCE-CHECKLIST.a2ml, or SOFTWARE-DEVELOPMENT-APPROACH.a2ml in the reposit
6666
6767
## ABI/FFI Standard
6868

69-
- ABI definitions: **Idris2** with dependent types (`src/abi/`).
69+
- ABI definitions: **Idris2** with dependent types (`src/interface/abi/`).
7070
- FFI implementation: **Zig** with C ABI compatibility (`ffi/zig/`).
7171
- Generated C headers: `generated/abi/`.
7272

0 commit comments

Comments
 (0)