docs: product pitch + compose example; fix meili all-field search; release notes - #2
Merged
Merged
Conversation
Hero now dual-leads on cost (avoided embed + upstream) and speed (live agentic bench: 0.1 ms hit vs 13.8 ms miss, ~138×, 89.5% HR). Agentic cache block adds cost/latency framing.
README adds: problem statement, Consider/Skip checklists, vs alternatives table (GPTCache/RedisVL, in-process memoize, LangChain cache). Leads with cost + faster search and the measured hit-rate proof. AGENTS.md adds a short Product framing block so in-repo agents don't drift the pitch when writing PR copy / external docs. Pins stability (experimental upstreams, peer = trusted network, no mTLS).
Tight citable box + 5 Qs that GEO/AEO engines love to quote: - Category / not-GPTCache / proof / integrate - FAQ covers what, vs GPTCache, when, how-to-try, how-to-prove
- Resolve previous semver tag (Resolve previous tag step) and emit a Compare link for the release body - Add Stability / Install / Docs sections above the auto-generated PR-grouped release notes - Mark prereleases (vX.Y.Z-rc.N) as prerelease and skip "make_latest" so vX.Y.Z stable still surfaces as Latest
Tightens the pitch: claim first, three numbers in parentheses, link.
User-facing example: bring up conproxy + Meilisearch with `docker compose up`, hit `/query` twice, see miss→hit. Pinned versions, healthcheck, non-root, in-compose DNS. README install + deployment + quickstart + docs table + examples/README all wired up. Known issue: v0.1.0 meilisearch adapter can return result_count=0 even with matching docs (showRankingScore config issue). Cache flow is independent and verified.
Root cause: MeilisearchConfig defaulted search_attributes to ["content"], so only the "content" field was searched. Documents with title/body but no content returned 0 results. Fix: empty search_attributes = search all fields (Meili default). pool.rs no longer injects ["content"]. Also fixed: hit_id() now handles numeric primary keys (JSON integer ids) in addition to string ids. The old MeiliHitExt::id() returned &str which couldn't represent integer ids. Tests: 20 meilisearch tests pass, clippy clean.
github-release job needs git history to resolve the previous semver tag. Also: clean up stale Meili troubleshooting row (blamed showRankingScore instead of the real content-only default) and rustdoc. Compose smoke verified: miss→hit with actual content, no content field needed, numeric id parsed correctly.
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
7 commits, 13 files, +507 / -35. Three themes:
1. Product docs (README + AGENTS.md)
2. Docker Compose example + docs
3. Bug fixes
Testing