docs: add set-up-memory guide (guides checkpoint 5)#40
Merged
Conversation
Fourth catalog entry: create a durable note under ~/.coven/memory/<familiar>/, list it with coven memory, then build and query the local semantic index with coven-memory ingest/search/status. Verified against scan_memory (cockpit_sources.rs:328), observe.rs run_memory, and the coven-memory crate CLI. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Set Up Memory” guide to the Guides section, documenting the end-to-end flow for durable Markdown notes plus building/searching the local semantic index, and updates the guides catalog + validation script to keep the docs set complete.
Changes:
- Add
Set Up Memoryguide covering note creation,coven memorylisting (incl. empty state /--json), andcoven-memoryingest/search/status viacargo run. - Register and link the new guide in the Guides nav (
meta.json) and catalog (index.mdx). - Extend
check-guides-docsto require the new page and pin key memory-related command mentions and a memory-model cross-link.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/check-guides-docs.mjs | Adds set-up-memory to required guides and pins memory-related mentions + requires a memory-model link. |
| content/docs/guides/set-up-memory.mdx | New step-by-step guide for creating/listing notes and ingesting/searching the local semantic index. |
| content/docs/guides/meta.json | Registers set-up-memory in the Guides pages list. |
| content/docs/guides/index.mdx | Adds a catalog link to the new “Set up memory” guide. |
This was referenced Jul 22, 2026
Describe the ~/.coven/memory/ directory once and list both index files, so archival.sqlite3 is not read as a cwd-relative path. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Checkpoint 5 of the guides-section goal, stacked on #39: the Set Up Memory guide — persistent notes plus the local semantic index, created, inspected, and searched end to end.
Changes
content/docs/guides/set-up-memory.mdx— 5 steps: create a Markdown note under~/.coven/memory/<familiar>/→coven memorylisting (incl. empty state and--json) →coven-memory ingest→ semanticsearch --familiar --k→status; local-only boundary called out; troubleshooting footercontent/docs/guides/index.mdx— catalog row linkedcontent/docs/guides/meta.json— page registeredscripts/check-guides-docs.mjs— pins for memory commands and the memory-model cross-linkVerified against source (
../coven@ 2850c53)scan_memory(cockpit_sources.rs:328): only.mdfiles directly undermemory/<familiar>/; title = file stem; excerpt = first paragraph; empty-dir → empty listrun_memory(observe.rs:423): reads via daemonGET /api/v1/memory(daemon is a stated prerequisite); prose renders FAMILIAR/TITLE/UPDATED/EXCERPT table and theNo memory files.empty statecoven-memorycrate (src/main.rs):ingest <path> --familiar,search <query> --familiar --k,status; default pathsarchival.tvim/archival.sqlite3; ships as a cargo workspace bin, not in the npm wrapper (npm/coven/package.json bins onlycoven) — guide usescargo run -p coven-memory --semantic-memory.mdxValidation
check-guides-docs,english-only,no-leading-h1,mermaid-parse,validate-links(0 errors) ✅npx fumadocs-mdx+npx tsc --noEmit+npx next build✅ — all four guide pages prerendered