Codex/readme llm wiki - #556
Open
sairin1202 wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the top-level README.md to reposition memU’s framing and simplify the “Quick start” section toward a host-adapter-centric workflow and “shared wiki” messaging.
Changes:
- Rebrands the README’s tagline and introductory description around a “shared LLM wiki” concept.
- Replaces the prior Python/CLI quick start examples with a shorter, host-adapter retrieval example (
memu-codex retrieve ...). - Removes detailed conceptual documentation sections (data model, retrieval explanation, multi-tenancy, development commands) from the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # memU | ||
|
|
||
| ### Personal memory, stored as files | ||
| ### Personal memory, stored as an LLM wiki |
| --- | ||
|
|
||
| memU is a 500-line memory system for AI agents. Agents write what's worth keeping as Markdown; memU stores it, embeds it, and retrieves ranked context in a single call — embeddings are the only model calls it makes. The entire memory logic lives in [`agentic.py`](src/memu/app/agentic.py) + [`service.py`](src/memu/app/service.py); everything else is pluggable storage and embedding transport. | ||
| memU is a lightweight, agent-driven memory system that gives users a shared LLM wiki across sessions, agents, and devices. Its core memory logic is only 500 lines — compact enough to inspect, understand, and adapt. It uses embedding-only retrieval with fully pluggable storage and embedding infrastructure. |
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
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.
📝 Pull Request Summary
Please provide a short summary explaining the purpose of this PR.
✅ What does this PR do?
🤔 Why is this change needed?
🔍 Type of Change
Please check what applies:
✅ PR Quality Checklist
feat:,fix:,docs:,memory base:)📌 Optional