Replace stale repo-seed template README with a real one
Some checks failed
Build and Deploy / build-push-deploy (push) Has been cancelled

Written from SCOPE.md/INTENT.md and direct source inspection. Requested
during reuse-surface REUSE-WP-0017-T05 review follow-up.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
2026-07-07 01:34:42 +02:00
parent f5539f103f
commit 4a9f93412d

View File

@@ -1,3 +1,52 @@
# repo-seed
# inter-hub
A git repository template to bootstrap coulomb projects from.
Specification and reference implementation of the **Interaction Hub
Framework (IHF)** — a governed, observable interaction substrate for
hub-based AI-enabled software systems.
IHF treats every meaningful UI element as a **governed interaction
artifact** rather than mere markup. It connects the full traceability
chain from rendered widget → user interaction → structured feedback →
requirement candidate → decision record → implementation change →
observed outcome, so UI evolution is evidence-based rather than
opinion-based.
## Status
Phases 09 of the implementation are complete (see `SCOPE.md` for the full
per-phase breakdown): specification, widget registry and event capture,
structured feedback and triage, governance and decision linkage, outcome
signals and regression detection, agent-assisted proposals, cross-framework
adapter contracts, friction/health observability, federated governance and
ownership, and a versioned external API (`/api/v2`) with OpenAPI, OAuth
client credentials, generated SDKs, and webhooks.
The core artifact model and schema are stable. This is a working reference
implementation, not just a spec — see `Web/Controller/` for the full set of
implemented controllers (governance, requirements, hub capability
manifests, federated policy overlays, deployment records, and more) and
`Test/` for the test suite.
## Stack
Built on IHP (the Integrated Haskell Platform) v1.5 + PostgreSQL.
```bash
devenv up
```
## Getting oriented
- **Full spec:** `specs/InteractionHubFrameworkSpecification_v0.1.md` (and
`_v0.2.md`) — 19 sections covering key concepts, core modules, and the
phased implementation plan
- **Scope and boundaries:** `SCOPE.md`
- **Architecture:** `ARCHITECTURE-LAYERS.md`, `specs/OperationalArchitecture_v0.1.md`
- **Build history:** `workplans/`
## Relevant when
Building or reviewing any hub dashboard or operator surface (dev-hub,
ops-hub, fin-hub), capturing and triaging feedback on existing hub UIs, or
defining governed widget identity for a new capability surface. See
`SCOPE.md` for the full relevant/not-relevant breakdown and related repos.