Skip to content

docs: rework README into a launch ramp with cited-retrieval proof#9

Merged
arhuman merged 1 commit into
mainfrom
refactor/rework-readme
Jul 1, 2026
Merged

docs: rework README into a launch ramp with cited-retrieval proof#9
arhuman merged 1 commit into
mainfrom
refactor/rework-readme

Conversation

@arhuman

@arhuman arhuman commented Jul 1, 2026

Copy link
Copy Markdown
Owner
  • restructure README: pain/contrast hook, "Try it in 60 seconds", real cited dialogue
  • add "Does it actually retrieve?" proof section with mnemos eval numbers
  • add examples/git-recipes OKF bundle as a lexical-friendly eval corpus (validated)
  • move config + full command table to docs/configuration.md and docs/commands.md
  • refresh demo-session.gif/tape to showcase semantic search (embed build), with a reproducibility note for the default lexical build
  • fix mnemos models install usage (requires a arg)
  • add "Semantic search (the embed build)" section: all-MiniLM-L6-v2 model, pure-Go inference via gomlx/onnx-gomlx (not the C++ ONNX Runtime), sugarme tokenizer, mean-pool + L2-normalize, embeddings storage, RRF (k=60) hybrid fusion, and linear-scan scaling
  • link it from the README Semantic search section (kept to one line)

- restructure README: pain/contrast hook, "Try it in 60 seconds", real cited dialogue
- add "Does it actually retrieve?" proof section with mnemos eval numbers
- add examples/git-recipes OKF bundle as a lexical-friendly eval corpus (validated)
- move config + full command table to docs/configuration.md and docs/commands.md
- refresh demo-session.gif/tape to showcase semantic search (embed build), with a
  reproducibility note for the default lexical build
- fix mnemos models install usage (requires a <model> arg)
- add "Semantic search (the embed build)" section: all-MiniLM-L6-v2 model,
  pure-Go inference via gomlx/onnx-gomlx (not the C++ ONNX Runtime), sugarme
  tokenizer, mean-pool + L2-normalize, embeddings storage, RRF (k=60) hybrid
  fusion, and linear-scan scaling
- link it from the README Semantic search section (kept to one line)
@arhuman arhuman merged commit 35de68a into main Jul 1, 2026
4 checks passed
@arhuman arhuman deleted the refactor/rework-readme branch July 4, 2026 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant