diff --git a/README.md b/README.md index f79f287..cd846c3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,25 @@ # EmbedRelay -Embedding continuity infrastructure for safe cross-model vector migration. +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ContextualWisdomLab/EmbedRelay) -The first executable milestone is developed through protected pull requests; the default branch remains intentionally minimal until exact-head CI and review gates pass. +EmbedRelay provides embedding-continuity infrastructure for safe, evidence-backed migration between vector models and index generations. + +## Responsibility + +EmbedRelay owns reusable contracts and runtime support for: + +- stable embedding-space identity and versioned migration plans; +- compatibility checks before vectors cross model or index boundaries; +- provenance that records the producing model, dimensions, normalization, and migration lineage; +- fail-closed cutover and rollback evidence for consumers. + +Product-domain meaning, Ubiquitous Language, source records, authorization, and release decisions remain with each product repository. EmbedRelay does not become a catalog, ontology publisher, model router, or product data authority. + +## Public documentation + +- [Repository overview](docs/index.md) +- [DeepWiki](https://deepwiki.com/ContextualWisdomLab/EmbedRelay) +- [ContextualWisdomLab organization](https://github.com/ContextualWisdomLab) ## Repository governance diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..95535ac --- /dev/null +++ b/docs/index.md @@ -0,0 +1,32 @@ +--- +title: EmbedRelay +description: Governed embedding identity and migration infrastructure for ContextualWisdomLab. +--- + +# EmbedRelay + +EmbedRelay helps services change embedding models or index generations without silently mixing incompatible vectors or losing the evidence needed to explain a migration. + +## What this repository owns + +- versioned identities for embedding spaces; +- model, dimension, normalization, and provenance contracts; +- compatibility validation at producer and consumer boundaries; +- migration, cutover, rollback, and verification evidence. + +## Boundary + +EmbedRelay transports and verifies embedding identity. It does not own a product's domain truth, Ubiquitous Language, source data, ontology publication, catalog policy, model routing, or authorization decisions. Consumers integrate through released contracts and an Anti-Corruption Layer rather than copying source or querying another service's database. + +## Failure behavior + +Unknown or incompatible embedding identity fails closed. A migration is not complete until the released producer contract, consumer version, provenance, and rollback evidence agree. + +## Navigate + +- [Source repository](https://github.com/ContextualWisdomLab/EmbedRelay) +- [README](https://github.com/ContextualWisdomLab/EmbedRelay#readme) +- [DeepWiki](https://deepwiki.com/ContextualWisdomLab/EmbedRelay) +- [ContextualWisdomLab](https://github.com/ContextualWisdomLab) + +Publication is complete only after this source reaches the protected default branch and the live GitHub Pages endpoint is verified.