Skip to content

docs: refresh the README for the current product - #147

Merged
spinsirr merged 2 commits into
mainfrom
docs/refresh-readme
Oct 7, 2026
Merged

spinsirr merged 2 commits into
mainfrom
docs/refresh-readme

Conversation

@corespeed-agent-ensemble

@corespeed-agent-ensemble corespeed-agent-ensemble Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

What changes

README only. No code, schema, or default changes.

  • Intro and feature list now cover code-aware memory: exact-commit Code Index, code search, callers/callees, and Code Evidence citation states.
  • New bullet for the joint context packet, POST /api/v1/context/retrieve.
  • Search bullet names the real channels: English and simple FTS, the CJK substring channel, and optional vectors. Reranking sees only authorized evidence; query planning sees only the question.
  • Architecture paragraph names packages/lore-core and states the boundary: the engine owns its SQL, but imports no driver and opens no connection. The OSS host owns both.
  • Quick start lists the four embedding providers (Ollama, Gemini, OpenAI, Vercel AI Gateway).
  • New "Connect an agent" steps: create an Agent in /agents, issue a credential, build the packages, run the MCP adapter.
  • Measurement bullet names the generation-based embedding rollout and the LongMemEval, LoCoMo, and MemoryAgentBench runners.
  • Development lists every check AGENTS.md requires before a PR.

For the PM

No product decisions. The README now advertises code-aware memory on the front page; say so if that should stay less prominent.

🤖 Generated with Claude Code

Agent and others added 2 commits October 7, 2026 21:04
Add code-aware memory and the joint context packet, the supported
embedding providers, a "Connect an agent" quick start, and the
benchmark runners. State that Lore Core owns its SQL but opens no
database connection; the OSS host owns the driver and connections.
List every check required before a pull request.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…very PR

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@spinsirr
spinsirr merged commit f0245a5 into main Oct 7, 2026
6 checks passed

@corespeed-hopper corespeed-hopper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved after two review rounds. No findings remain.

Reviewed the README-only change from merge base 9c6f2ab through this exact commit, including the incremental wording fixes. Checked the architecture, Agent/MCP setup, provider support, retrieval and Code Evidence claims against repository source and guides. All 15 relative README links resolve; referenced guide anchors exist; git diff --check passes. No runtime or schema changes.

All six configured CI jobs passed on 08d9928, including All checks: https://github.com/corespeed-io/lore/actions/runs/37687111219 . No full local suites were rerun for this documentation-only diff.

The PR description records the increased prominence of code-aware memory for the PM. Reviewer session: f2dc24f5-512e-470e-8af4-21f58f5b6153.

Publication note: spinsirr merged this PR at 2026-10-07 21:14:17 UTC during the final publication check; this records the completed review of the same head.

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