Skip to content

Commit d762c26

Browse files
docs(readme): convert README.adoc -> Markdown README.md (#41)
README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2a2769f commit d762c26

2 files changed

Lines changed: 130 additions & 135 deletions

File tree

README.adoc

Lines changed: 0 additions & 135 deletions
This file was deleted.

README.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
# Overview
7+
8+
The **clade-index** is the central registry for the entire hyperpolymath
9+
ecosystem. It provides a VeriSimDB-backed taxonomy of 200+ repositories
10+
organised into 12 clades, with a pointer authority system for tracking
11+
data ownership, and VCL queries for dashboards, drift detection, and
12+
work tracking.
13+
14+
**Map and territory**: This registry is the map — queryable,
15+
presentable, always clean. Repositories are the territory. Editing the
16+
map never damages the territory.
17+
18+
# Clade Taxonomy
19+
20+
| Code | Clade | Description |
21+
|----|----|----|
22+
| `fv` | Formal Verification & Proofs | Provable correctness, reversibility, dependent types |
23+
| `nl` | Nextgen Languages | Compilers, runtimes, language tooling |
24+
| `rm` | Repo Management & Tooling | Scaffolding, graph analysis, bot orchestration |
25+
| `gv` | Governance & Standards | Licensing, compliance, policy enforcement |
26+
| `db` | Databases | Database engines, query languages |
27+
| `ap` | Applications | End-user apps, web, desktop, services |
28+
| `ix` | Infrastructure & Cloud | Containers, deployment, sysadmin |
29+
| `dx` | Developer Ecosystem | Dev tools, editor integrations, bindings |
30+
| `pt` | Protocols & Interop | Internet standards, protocol implementations |
31+
| `ax` | AI & Neurosymbolic | ML, neural proof synthesis, AI governance |
32+
| `gm` | Games & Interactive | Game engines, interactive experiences |
33+
| `sc` | Security | Scanning, vulnerability management, access control |
34+
35+
# Structure
36+
37+
gv-clade-index/
38+
├── 0-AI-MANIFEST.a2ml # AI agent entry point
39+
├── .machine_readable/ # State, meta, ecosystem, clade declaration
40+
├── verisim/
41+
│ ├── config.a2ml # VeriSimDB instance config
42+
│ ├── schema/ # VCL schemas (7 entity types)
43+
│ │ ├── repo.vcl # Repository octad
44+
│ │ ├── clade.vcl # Clade definition
45+
│ │ ├── todo.vcl # Work items
46+
│ │ ├── observation.vcl # Bot/agent findings
47+
│ │ ├── feedback.vcl # External feedback
48+
│ │ ├── lineage.vcl # Inflate/deflate history
49+
│ │ └── forge-identity.vcl # PK/FK forge mapping
50+
│ ├── seed/ # Initial data
51+
│ │ ├── clades.a2ml # 12 clade definitions
52+
│ │ ├── repos.a2ml # 200 repo registrations
53+
│ │ └── forges.a2ml # Forge account definitions
54+
│ └── queries/ # Pre-built VCL queries
55+
│ ├── dashboard.vcl # Ecosystem overview
56+
│ ├── stale.vcl # Inactive repos
57+
│ ├── orphans.vcl # Unclassified repos
58+
│ ├── drift.vcl # State divergence
59+
│ ├── bot-findings.vcl # Unacknowledged bot observations
60+
│ ├── blocked.vcl # Blocked work items
61+
│ ├── cross-clade-deps.vcl # Cross-boundary dependencies
62+
│ └── feedback-status.vcl # Feedback resolution tracking
63+
├── sync/ # Sync tooling (Phase 2)
64+
├── views/ # Generated outputs (not committed)
65+
└── contractiles/
66+
└── must/
67+
└── clade-hygiene.a2ml # Every repo MUST have CLADE.a2ml
68+
69+
# Portal Architecture
70+
71+
hyperpolymath.github.io Cloudflare Worker VeriSimDB (VPS)
72+
(ReScript/WASM) --> (API Gateway) --> (Rust + Elixir)
73+
|
74+
Public read --------------------------------------------------> KV snapshot
75+
LLM query ------------------- API key ---------------------> Read-only
76+
Contributor ------------------ OAuth -----------------------> Scoped access
77+
Bot writes ------------------- Signed JWT ------------------> Write observations
78+
79+
# Identity Model
80+
81+
Every repo has:
82+
83+
- **Primary key**: GitHub (`gh:hyperpolymath/{name}`)
84+
85+
- **Foreign keys**: GitLab, Bitbucket, Codeberg, SourceHut mirrors
86+
87+
- **UUID**: Deterministic v5, derived from
88+
`github.com/hyperpolymath/{name}`
89+
90+
- **Clade**: Primary (1) + secondary (0+)
91+
92+
- **Lineage**: standalone, monorepo, monorepo-child, inflated, deflated
93+
94+
# Pointer Authority
95+
96+
Every cached value in VeriSimDB declares its canonical source:
97+
98+
- `pointer` — value lives in the repo (VeriSimDB caches + drift-detects)
99+
100+
- `local` — VeriSimDB owns it (TODOs, bot observations)
101+
102+
- `derived` — computed from other values (clade health scores)
103+
104+
# Contractile System
105+
106+
This repo includes a `clade-hygiene.a2ml` contractile:
107+
108+
- **CLADE-001**: Every repo must have `.machine_readable/CLADE.a2ml`
109+
110+
- **CLADE-002**: CLADE.a2ml must declare a primary clade code
111+
112+
- **CLADE-003**: Primary clade code must be one of the 12 valid codes
113+
114+
# Implementation Phases
115+
116+
| Phase | Deliverable | Status |
117+
|----|----|----|
118+
| 0 | Clade taxonomy, repo seed, VCL schema | **Complete** |
119+
| 1 | Deploy CLADE.a2ml to all 200 repos | Pending |
120+
| 2 | VeriSimDB instance on VPS | Pending |
121+
| 3 | Cloudflare Worker API (hardened, tested, CI-gated) | In progress (~60%) |
122+
| 4 | ReScript/typed-WASM portal | Pending |
123+
| 5 | LLM query endpoint | Pending |
124+
| 6 | Bot write endpoints | Pending |
125+
| 7 | Contributor OAuth | Pending |
126+
| 8 | Repo lockdown | Pending |
127+
128+
# License
129+
130+
<a href="LICENSE" class="0">MPL-2</a>

0 commit comments

Comments
 (0)