Skip to content

docs: make memory-mini install guidance truthful - #1

Open
JustinJLeopard wants to merge 1 commit into
mainfrom
codex/public-truth-memory-20260822
Open

docs: make memory-mini install guidance truthful#1
JustinJLeopard wants to merge 1 commit into
mainfrom
codex/public-truth-memory-20260822

Conversation

@JustinJLeopard

Copy link
Copy Markdown
Owner

Summary

  • replace unavailable PyPI install commands with direct Git installs for the base package and optional embed extra
  • replace broad “What It Proves” language with source-linked “What to inspect” implementation details
  • state the repository's bounded scope as a local reference rather than a hosted service or production-readiness claim

Evidence

  • base: main at 9b9ffeeda7958abd15191837fe2a93db27b8e8f3
  • https://pypi.org/pypi/memory-mini/json: HTTP 404 on 2026-08-22
  • disposable virtual environment:
    • both documented git+https install forms succeeded
    • Git resolved main to 9b9ffeeda7958abd15191837fe2a93db27b8e8f3
    • wheel build and install succeeded as memory-mini 0.1.0
    • base import, SQLite upsert smoke, optional NumPy import, and CLI help succeeded
  • repository tests: 67 passed, 1 skipped (the no-NumPy case skipped because the optional extra was installed)
  • git diff --check origin/main...HEAD: passed
  • changed paths: README.md only

Boundary

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.py still emits pip 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.

Copilot AI lite review requested due to automatic review settings August 22, 2026 05:18

Copilot AI 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.

🟢 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 and embed extra.
  • 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.

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.

3 participants