|
| 1 | +<!-- SPDX-License-Identifier: PMPL-1.0-or-later --> |
| 2 | +<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> --> |
| 3 | +# TOPOLOGY.md — gv-clade-index |
| 4 | + |
| 5 | +## Purpose |
| 6 | + |
| 7 | +gv-clade-index is the central registry for the hyperpolymath ecosystem, providing a VeriSimDB-backed taxonomy of 200+ repositories organised into 12 clades (fv, nl, rm, gv, db, ap, ix, dx, pt, ax, gm, sc). It exposes a Cloudflare Worker API for dashboards, drift detection, and work-tracking VQL queries. The index is the canonical map of the ecosystem — editing it never modifies the repositories it describes. |
| 8 | + |
| 9 | +## Module Map |
| 10 | + |
| 11 | +``` |
| 12 | +gv-clade-index/ |
| 13 | +├── verisimdb/ # VeriSimDB instance (clade data store) |
| 14 | +│ ├── config.a2ml # Database instance configuration |
| 15 | +│ ├── schema/ # VQL schemas (repo, clade, pointer, etc.) |
| 16 | +│ ├── queries/ # Named VQL queries for dashboards |
| 17 | +│ └── seed/ # Initial seed data (200+ repos) |
| 18 | +├── worker/ # Cloudflare Worker (edge API) |
| 19 | +│ ├── wrangler.toml # CF Worker deployment config |
| 20 | +│ └── src/ |
| 21 | +│ ├── index.js # Worker entry point + request routing |
| 22 | +│ └── verisimdb.js # VeriSimDB client for the worker |
| 23 | +├── sync/ # Sync scripts (GitHub → VeriSimDB) |
| 24 | +│ ├── deploy-clade-a2ml.sh # Deploy A2ML manifests to clades |
| 25 | +│ ├── export-json.sh # Export registry as JSON |
| 26 | +│ ├── parse-repos.sh # Parse repo metadata |
| 27 | +│ └── seed-verisimdb.sh # Seed the VeriSimDB instance |
| 28 | +├── src/ # Idris2 ABI + source contracts |
| 29 | +│ ├── core/ # Core clade index logic |
| 30 | +│ ├── contracts/ # API contract definitions |
| 31 | +│ ├── bridges/ # Integration bridges |
| 32 | +│ └── aspects/ # Cross-cutting concerns |
| 33 | +├── tests/ # Integration tests |
| 34 | +├── docs/ # Architecture documentation |
| 35 | +└── verification/ # Formal verification proofs |
| 36 | +``` |
| 37 | + |
| 38 | +## Data Flow |
| 39 | + |
| 40 | +``` |
| 41 | +[GitHub repos / CI events] |
| 42 | + │ sync scripts (sync/*.sh) |
| 43 | + ▼ |
| 44 | +[VeriSimDB instance] ──► [verisimdb/schema/ VQL] ──► [verisimdb/queries/ named queries] |
| 45 | + │ |
| 46 | + ▼ |
| 47 | +[worker/src/verisimdb.js] ──► [worker/src/index.js] ──► [Cloudflare Worker edge] |
| 48 | + │ |
| 49 | + ┌─────────────────┴─────────────────┐ |
| 50 | + ▼ ▼ |
| 51 | + [Dashboard consumers] [Drift detection CI] |
| 52 | + (clade listing, repo search) (stale/missing repos) |
| 53 | +``` |
0 commit comments