docs(memory): document builtin recall + close spec/generated-files gaps#507
Merged
Conversation
…_GUIDE, MASTER_SPEC, GENERATED_FILES; add memory.db to gitignore Closes #491 Signed-off-by: magicpro97 <magicpro97@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates VibeFlow’s documentation to describe the new memory recall modes (builtin vs claude-mem), fills gaps in the master spec and generated-files inventory, and syncs those updates into the landing wiki copies. It also adds the builtin SQLite index file to .gitignore so local recall artifacts aren’t committed.
Changes:
- Document
vf config memorymodes (builtin | claude-mem | off | status) across user guide and command reference. - Add a “Memory recall” design-intent section to the master spec and list the memory DB / workflow policy as runtime-generated artifacts.
- Gitignore
.vibeflow/knowledge/memory.db*(including WAL/SHM siblings).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
.gitignore |
Ignores builtin memory SQLite index artifacts under .vibeflow/knowledge/. |
docs/USER_GUIDE.md |
Adds memory modes table + enable/disable examples. |
docs/COMMAND_REFERENCE.md |
Updates vf config memory reference and mode behavior table. |
docs/MASTER_SPEC.md |
Adds a “Memory recall” section describing providers + injection points. |
docs/GENERATED_FILES.md |
Lists src/memory/ and adds runtime-generated file entries. |
landing/src/content/wiki/USER_GUIDE.md |
Wiki mirror of the user guide memory updates. |
landing/src/content/wiki/COMMAND_REFERENCE.md |
Wiki mirror of the command reference memory updates. |
landing/src/content/wiki/MASTER_SPEC.md |
Wiki mirror of the master spec memory section. |
landing/src/content/wiki/GENERATED_FILES.md |
Wiki mirror of the generated-files updates. |
Comment on lines
+129
to
+131
| | `off` / `false` | No recall — nothing injected into prompts (default) | | ||
| | `builtin` | Zero-config BM25/FTS5 recall from `.vibeflow/knowledge/decisions.md` via `bun:sqlite`; lazy-indexed on mtime; generates `.vibeflow/knowledge/memory.db` (gitignored) | | ||
| | `claude-mem` | Shells `claude-mem search`; requires `claude-mem` installed separately | |
| Enable claude-mem (external): | ||
|
|
||
| ```bash | ||
| vf config memory claude-mem # requires: npm i -g claude-mem (or vf init --memory) |
Comment on lines
+129
to
+131
| | `off` / `false` | No recall — nothing injected into prompts (default) | | ||
| | `builtin` | Zero-config BM25/FTS5 recall from `.vibeflow/knowledge/decisions.md` via `bun:sqlite`; lazy-indexed on mtime; generates `.vibeflow/knowledge/memory.db` (gitignored) | | ||
| | `claude-mem` | Shells `claude-mem search`; requires `claude-mem` installed separately | |
| Enable claude-mem (external): | ||
|
|
||
| ```bash | ||
| vf config memory claude-mem # requires: npm i -g claude-mem (or vf init --memory) |
Comment on lines
+130
to
+131
| vf config memory builtin # enable built-in BM25/FTS5 recall (zero deps) | ||
| vf config memory claude-mem # enable claude-mem recall (requires claude-mem installed) |
Comment on lines
+140
to
+142
| | `false` / `off` | No recall injected | | ||
| | `builtin` | bun:sqlite FTS5 index of `.vibeflow/knowledge/decisions.md`; generates `.vibeflow/knowledge/memory.db` (gitignored) | | ||
| | `claude-mem` | Shells `claude-mem search`; requires separate `claude-mem` install | |
Comment on lines
+130
to
+131
| vf config memory builtin # enable built-in BM25/FTS5 recall (zero deps) | ||
| vf config memory claude-mem # enable claude-mem recall (requires claude-mem installed) |
Comment on lines
+140
to
+142
| | `false` / `off` | No recall injected | | ||
| | `builtin` | bun:sqlite FTS5 index of `.vibeflow/knowledge/decisions.md`; generates `.vibeflow/knowledge/memory.db` (gitignored) | | ||
| | `claude-mem` | Shells `claude-mem search`; requires separate `claude-mem` install | |
|
|
||
| VibeFlow ships a built-in recall layer (`MemoryProvider` seam, two providers): | ||
|
|
||
| - **builtin** (default opt-in): bun:sqlite FTS5 over `.vibeflow/knowledge/decisions.md`; zero deps; lazy-indexed on mtime. |
|
|
||
| VibeFlow ships a built-in recall layer (`MemoryProvider` seam, two providers): | ||
|
|
||
| - **builtin** (default opt-in): bun:sqlite FTS5 over `.vibeflow/knowledge/decisions.md`; zero deps; lazy-indexed on mtime. |
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
.gitignore: add.vibeflow/knowledge/memory.db*COMMAND_REFERENCE.md: updatevf config memorymodes (builtin|claude-mem|off|status), add memory.db generated fileUSER_GUIDE.md: add builtin/claude-mem opt-in instructionsMASTER_SPEC.md: add memory recall design intent sectionGENERATED_FILES.md: add memory.db + WORKFLOW_POLICY claude-mem guide entrieslanding/wiki/: sync all updated docsCloses #491