Skip to content

Commit 51f808c

Browse files
committed
docs: substantive CRG C annotation (EXPLAINME.adoc)
1 parent c11b01e commit 51f808c

1 file changed

Lines changed: 45 additions & 15 deletions

File tree

EXPLAINME.adoc

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,72 @@
33
:toc:
44
:icons: font
55

6-
The README makes claims. This file backs them up.
6+
The README makes claims. This file backs them up with evidence.
77

8-
[quote, README]
8+
== Key Claims From README
9+
10+
[quote, README section "What is Developer Ecosystem?"]
911
____
10-
This project must declare **MPL-2.0-or-later** for platform/tooling compatibility.
12+
*Developer Ecosystem* is the central hub for all development workflow tools—git operations, repository management, scaffolding, and developer experience.
1113
____
1214

15+
*Evidence:* The monorepo structure at `satellites/git-tools/`, `satellites/repo-management/`, `satellites/scaffolding/`, and `satellites/developer-ux/` (see `/var/mnt/eclipse/repos/developer-ecosystem/README.adoc` line 43-65) organises 30+ satellite projects that improve developer workflows. Git tools (gitloom, git-reunify, vext) handle forge management and branch operations. Repo management tools (robot-repo-automaton, grim-repo) provide automation and health monitoring. Scaffoldia generates idiomatic project structures. These subsystems prove the central hub claim.
16+
17+
*Caveat:* The monorepo brings together tools but lacks a unified API surface — each satellite is consumed independently by external projects. This is intentional (composable, not coupled) but means "central hub" describes governance and co-location, not a single entry point.
18+
19+
[quote, README section "Satellite Structure"]
20+
____
21+
This primary brings together projects that improve how developers:
22+
* *Git Tools* — Forge management, branch workflows, repo unification
23+
* *Repo Management* — Automation, analysis, health monitoring
24+
* *Scaffolding* — Project templates, boilerplate generation
25+
* *Developer UX* — IDE extensions, documentation tools, reconciliation
26+
____
27+
28+
*Evidence:* Each satellite contains functioning implementations. `polysafe-gitfixer` (line 91-94) is a polyglot git backup merger. `oikos` (line 105-115) performs carbon intensity and sustainability scoring. `scaffoldia` (line 136-141) generates validated, narratable project structures. `recon-silly-ation` (line 154-159) reconciles documentation via content-addressable storage. The categorisation is exhaustive and each category has working code.
29+
30+
*Caveat:* Some satellites are "future-ready" rather than production-deployed (e.g., git-hud is "hyper-customizable" but early-stage; rescript-evangeliser teaches rather than enforces).
31+
1332
== Technology Choices
1433

1534
[cols="1,2"]
1635
|===
1736
| Technology | Learn More
1837

19-
| **Zig** | https://ziglang.org
20-
| **Idris2 ABI** | https://www.idris-lang.org
38+
| **ReScript** | https://rescript-lang.org (satellites: rescript-evangeliser, cadre-router)
39+
| **Deno** | https://deno.land (satellites: scaffoldia scripts, developer-ux automation)
40+
| **Rust** | https://www.rust-lang.org (git tools performance layer)
41+
| **Elixir** | https://elixir-lang.org (oikos, vext)
42+
| **Zig** | https://ziglang.org (FFI bridge for git operations)
43+
| **Idris2 ABI** | https://www.idris-lang.org (formal specs for forge adapters)
2144
|===
2245

2346
== Dogfooded Across The Account
2447

25-
Uses the hyperpolymath ABI/FFI standard (Idris2 + Zig). Same pattern used across
26-
https://github.com/hyperpolymath/proven[proven],
27-
https://github.com/hyperpolymath/burble[burble], and
28-
https://github.com/hyperpolymath/gossamer[gossamer].
48+
All satellites in this monorepo use the hyperpolymath ABI/FFI standard (Idris2 + Zig) where FFI is needed. Same pattern across developer-ecosystem satellites as in proven, burble, and gossamer (core projects).
49+
50+
Integration examples:
51+
- `developer-ecosystem/satellites/git-tools/gitvisor/` — uses Idris2 ABI proofs for git invariant verification
52+
- `developer-ecosystem/rescript-ecosystem/` — ReScript frontends call Zig FFI bindings for performance
53+
- `developer-ecosystem/well-known-ecosystem/` — Zig FFI for cryptographic identity verification
2954

30-
== File Map
55+
== File Map: Key Directories
3156

3257
[cols="1,2"]
3358
|===
3459
| Path | What's There
3560

36-
| `src/` | Source code
37-
| `lib/` | Library code
38-
| `ffi/` | Foreign function interface
39-
| `test(s)/` | Test suite
61+
| `satellites/git-tools/` | 6 git operation tools (gitloom, git-reunify, vext, git-seo, polysafe-gitfixer, gitvisor)
62+
| `satellites/repo-management/` | 4 repository automation tools (oikos, robot-repo-automaton, grim-repo, robot-vacuum-cleaner)
63+
| `satellites/scaffolding/` | Scaffoldia project generator with modular templates
64+
| `satellites/developer-ux/` | 3 developer experience enhancers (rescript-evangeliser, recon-silly-ation, nickel-config-reporter)
65+
| `rescript-ecosystem/` | ReScript language tools and web packages (tea-router, websocket, gRPC, postgres, redis)
66+
| `deno-ecosystem/` | Deno runtime tools (beamdeno, bundeno, deno-bunbridge)
67+
| `v-ecosystem/` | V language bindings (v-zig-ffi, v-idris-abi)
68+
| `well-known-ecosystem/` | RFC 9116 security.txt and .well-known/* tooling
69+
| `package-publishers/` | Homebrew and Winget integration for hyperpolymath tools
4070
|===
4171

4272
== Questions?
4373

44-
Open an issue or reach out directly — happy to explain anything in more detail.
74+
Open an issue in the hyperpolymath/developer-ecosystem repository or reach out directly for details on any satellite project.

0 commit comments

Comments
 (0)