docs: make memory-mini install guidance truthful - #1
Open
JustinJLeopard wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
README-only changes are consistent with the repository structure (linked files/behavior) and the packaging configuration (no required deps; embed extra present).
Pull request overview
Updates the README to accurately describe memory-mini as a small, local reference implementation and to provide installation instructions that work today (via direct Git installs rather than a non-existent PyPI release).
Changes:
- Reframes the project description from broad “What it proves” claims to concrete “What to inspect” bullets linking to the relevant source files.
- Replaces
pip install memory-mini...PyPI instructions with working PEP 508 direct Git install commands for base andembedextra. - Adds an explicit note that there is currently no PyPI release.
File summaries
| File | Description |
|---|---|
| README.md | Aligns project scope language with repository reality and updates install guidance to direct Git installs (base + embed). |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
embedextraEvidence
mainat9b9ffeeda7958abd15191837fe2a93db27b8e8f3https://pypi.org/pypi/memory-mini/json: HTTP404on 2026-08-22git+httpsinstall forms succeededmainto9b9ffeeda7958abd15191837fe2a93db27b8e8f3memory-mini 0.1.067 passed, 1 skipped(the no-NumPy case skipped because the optional extra was installed)git diff --check origin/main...HEAD: passedREADME.mdonlyBoundary
This PR is a source-integration proposal only. Do not merge or deploy it as part of this lane. It does not change repository metadata/settings, pins, runtime state, packaging code, or dependencies.
Known follow-up
src/memory_mini/embeddings.pystill emitspip install memory-mini[embed]when NumPy is absent. That source-code string is outside this README-only PR and remains a separate truth-repair candidate.