Skip to content

docs: standalone Elume quickstart, genealogy walkthrough, and graphify boundaries#9

Merged
bionicbutterfly13 merged 5 commits into
mainfrom
feature/elume-standalone-quickstart--codex
May 11, 2026
Merged

docs: standalone Elume quickstart, genealogy walkthrough, and graphify boundaries#9
bionicbutterfly13 merged 5 commits into
mainfrom
feature/elume-standalone-quickstart--codex

Conversation

@bionicbutterfly13
Copy link
Copy Markdown
Owner

Summary

  • Establish library-first onboarding: standalone docs/quickstart.md that runs without Dionysus, FastAPI, Graphiti, Neo4j, or MemEvolve, plus inlined value example.
  • Add docs/elume-memevolve-genealogy.md (746 lines): first-principles walkthrough of MemEvolve, the memevolve_* work in Dionysus 3, how it became Elume, and what LinOSS does inside the substrate. Every claim is anchored to a file path so a reader can verify against source.
  • Codify Graphify boundaries in AGENTS.md (symlinked from CLAUDE.md / GEMINI.md) and .graphifyignore so agents stop treating graphify-out/ as ambient context.
  • Record the session reflection that drove the framing shift toward library-first docs.

Test plan

  • pytest tests/ — 1194 passed
  • ruff check src/ tests/ — clean
  • git diff --check — no whitespace issues
  • Reviewer skim of docs/quickstart.md end-to-end against current public API
  • Reviewer spot-check 2–3 file:line citations in docs/elume-memevolve-genealogy.md

@bionicbutterfly13
Copy link
Copy Markdown
Owner Author

Quickstart smoke-test verified end-to-end against PyPI

Ran docs/quickstart.md verbatim in two environments:

  1. Local editable install (.venv at HEAD).
  2. Fresh python3 -m venv && pip install elume==0.4.0 from PyPI.

Both produced identical output:

verdict: PASS
new children: ['balanced.jitter.058c4d41', 'balanced.jitter.f36ce5cf']
population: ['balanced', 'balanced.jitter.058c4d41', 'balanced.jitter.f36ce5cf', 'bold', 'careful']
post-state hash: 8b6ce6baf738630f9c3654a2207843170d7989bb5abbd16fd462d764a86a0c20
replay matched: True

The post-state hash matched byte-for-byte across the two environments — replay determinism holds across the local source and the published package. The "Reviewer skim of docs/quickstart.md end-to-end against current public API" check from the PR test plan is now verified.

Citation spot-checks for docs/elume-memevolve-genealogy.md are still open for human reviewer.

@bionicbutterfly13
Copy link
Copy Markdown
Owner Author

Citation spot-check on docs/elume-memevolve-genealogy.md — verified

File-existence: 14/14 cited files exist (13 in this repo, 11 in dionysus3 — all api/services/memevolve_*, api/models/memevolve.py, api/routers/memevolve.py, docs/oss-extraction/memevolve-upstream.md).

Line-anchored citations spot-checked:

Citation Verified
src/elume/adapters/memevolve/provider.py:70class ElumeMemoryProvider exact match
src/elume/adapters/memevolve/provider.py:391_apply_curiosity_rerank exact match
src/elume/adapters/memevolve/encode.py:36encode_query exact match
src/elume/adapters/memevolve/encode.py:90-135 → LinOSS blend path range correct (LinOSS enrichment + 50/50 blend)
src/elume/adapters/memevolve/retrieve.py:55retrieve_ranked_memories exact match
src/elume/linoss/encoder.py:1-31 → encoder docstring exact match (ends at line 31)
dionysus3/api/models/memevolve.py:217-229ArchitectureGenotype exact match
docs/adapters/memevolve.md:49-89 → MemEvolve registration steps exact match
docs/adapters/memevolve.md:140-145 → platform fingerprint string exact match

The doc is verifiable end-to-end. Both PR test-plan reviewer items are now closed:

  • Reviewer skim of docs/quickstart.md end-to-end against current public API (PyPI smoke test in prior comment)
  • Reviewer spot-check 2–3 file:line citations in docs/elume-memevolve-genealogy.md (9 spot-checked, all exact)

Ready for human merge approval.

@bionicbutterfly13 bionicbutterfly13 merged commit 3bc7885 into main May 11, 2026
2 checks passed
@bionicbutterfly13 bionicbutterfly13 deleted the feature/elume-standalone-quickstart--codex branch May 11, 2026 05:08
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