[lore 7/7] OTel/slog audit + docs + release prep#7
Merged
Conversation
Eliminates three U+2014 em-dash characters in source comments and test strings per the no-em-dash style constraint.
Full release-ready README: quickstart, interface overview, Path A/B distinction, K8s production deployment patterns, reference impl table, configuration guide, stability disclaimer, attribution. Removes any internal path references and restructures per public-reader requirements.
CHANGELOG follows Keep-a-Changelog format with v0.1.1 entry describing all shipped packages and components. doc/ARCHITECTURE.md covers the three-interface design, Path A vs Path B, reference impl scale limits, RRF fusion rationale, and caller-owned deps. doc/INTERFACES.md is a condensed method-level reference for Store, Embedder, VectorStore, Retriever, Ingester, and the rrf.Fuse utility.
Each example is a compile-checked Example* function in a _test.go file. Covers: lore (Kind, AllKinds, Entry, SearchOpts), store (inscribe+get, searchText, addEdge), vector (upsert+search, delete), retrieve (bm25 search, rrf.Fuse), ingest (heuristic Process). All examples pass go test -race.
Two bugs surfaced by E2E exerciser: 1. hybrid.Retriever ignored opts.Kinds and opts.Tags after hydration. The vector arm documents Kind/Tag filters as advisory, expecting the Retriever to post-filter via Store.Get. The Retriever only post-filtered by Project, allowing vector-arm hits with non-matching kinds to leak into results. Added containsKind / containsAllTags post-filter. 2. DeleteBySource failed with FOREIGN KEY constraint when an entry was referenced by an edge. The edges FK to entries(id) lacked ON DELETE CASCADE, so deleting an entry that had any edge errored out. Added ON DELETE CASCADE to both edges FKs. Schema change is to migration 001 directly (no v0.1.x tag has shipped yet, so editing the baseline is safe and avoids a stub follow-up migration in the very first release).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Final consolidation PR for lore v0.1.1. Transforms the 6-PR feature stack into a release-ready library:
Tag v0.1.1 NOT pushed in this PR. Manual maintainer step after merge.
Test plan
go vet ./...passesgo build ./...passesgo test -race -count=1 ./...passesgrep -rEn $'—' . | grep -v '\.git/' | grep -v 'pkg/lore/embed/bge/model/'returns zero matchesgrep -rn '~/\|Synology\|Obsidian\|/Users/\|QUEST-\|LORE-\|ENTRY-' . | grep -v '\.git/'returns zero matches