Skip to content

docs: add Prerequisites block to memory guide#1665

Merged
itomek merged 4 commits into
amd:mainfrom
somo9909:fix/prerequisites-memory-guide
Jun 26, 2026
Merged

docs: add Prerequisites block to memory guide#1665
itomek merged 4 commits into
amd:mainfrom
somo9909:fix/prerequisites-memory-guide

Conversation

@somo9909

@somo9909 somo9909 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Contributes to #1077

First of the ~14 guides listed in #1077. Linked as "Contributes to" (not "Fixes") so merging this keeps the issue open to track the remaining guides.

What this PR does

Adds a Prerequisites block to docs/guides/memory.mdx
modelled after docs/guides/code.mdx (lines 55-90).

The block covers:

  • Install path (developer clone)
  • Extras required: [dev, rag]
  • Lemonade server must be running
  • Examples folder is inside the cloned repo

Notes

Starting with memory.mdx first for feedback before
updating the remaining 13 guides.

@github-actions github-actions Bot added the documentation Documentation changes label Jun 15, 2026
@somo9909

Copy link
Copy Markdown
Contributor Author

Hi @kovtcharov! This is my first guide update for #1077.
I've added the Prerequisites block to memory.mdx following
the code.mdx template. Please let me know if any changes
are needed before I update the remaining 13 guides.

@kovtcharov

Copy link
Copy Markdown
Collaborator

@claude review this update to the guide. Should we include Gaia init and Agent UI for targeting different users when onboarding with memory, not just developers?

@github-actions

Copy link
Copy Markdown
Contributor

Yes — the Prerequisites should cover end users too, because the guide's own body recommends the Agent UI as the primary way to enable memory (gaia chat --ui, the Memory Dashboard), yet the new block only describes the developer clone path. A reader who followed the recommended UI flow won't recognize themselves in these prereqs.

Quickstart already splits these audiences (docs/quickstart.mdx: Agent UI desktop app for end users → gaia init → Manual/Clone for developers), so mirroring that here keeps things consistent. A <Tabs> block — the same component quickstart uses — is the cleanest fit:

  • Agent UI (end users): install the desktop app; it sets up the backend and bundles the RAG runtime automatically, so no manual extras. Enable memory from the Memory Dashboard / gaia chat --ui.
  • Developers: the current clone + uv pip install -e ".[dev,rag]" block.

One accuracy note in your favor, @somo9909: the [rag] extra is genuinely required for the developer path — memory loads faiss + sentence-transformers + numpy directly (src/gaia/agents/base/memory.py). The [ui]/Agent UI install pulls those same deps in for you (#845), which is why the UI path needs no extras line.

Minor nit: the diff dropped the trailing newline at end of file — worth restoring.

Great first contribution — splitting the prereqs by audience before rolling out to the other 13 guides will set a good template.

@kovtcharov

Copy link
Copy Markdown
Collaborator

Hi @somo9909, can you comment when this PR will be ready for review?

@itomek itomek left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @somo9909 — this is exactly the right shape for the Prerequisites block, and a great template to roll out to the rest. The /setup/quickstart#for-developers + #manual-install swap is correct (both anchors resolve), and following the code.mdx structure is just what the issue asked for.

I've switched the PR description from Fixes #1077 to Contributes to #1077 so merging this won't auto-close the issue — let's keep #1077 open to track the remaining 13 guides.

Two small cosmetic notes (neither blocks merge):

  1. The install command uses .[dev,rag] but the Extras required bullet lists only [rag] — left an inline suggestion to align them (and [rag] is the right requirement: memory's recall uses FAISS, which ships in [rag]).
  2. The edit dropped the file's trailing newline (\ No newline at end of file in the diff) — worth restoring for a clean EOF.

The template looks good to me — once those are in, you're clear to apply the same block across the other 13 guides. Nice first contribution! 🎉

Comment thread docs/guides/memory.mdx Outdated
@itomek itomek marked this pull request as ready for review June 26, 2026 14:31
@itomek itomek requested a review from kovtcharov-amd as a code owner June 26, 2026 14:31

@itomek itomek left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied the two cosmetic fixes directly on the branch (the Extras required bullet now matches the .[dev,rag] install command, and the trailing newline is restored) and approving. Thanks again @somo9909 — the template's in great shape, and you're clear to roll the same block out across the remaining guides tracked in #1077. 🎉

@itomek itomek changed the title docs: add Prerequisites block to memory guide (fixes #1077) docs: add Prerequisites block to memory guide Jun 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Verdict: Approve with suggestions — safe to merge after a quick look at one bullet.

This adds a Prerequisites block to the memory guide (install path, [dev,rag] extras, Lemonade running) and repoints the intro link from /setup to the quickstart developer/manual-install anchors. The technical claims check out: memory recall really does use the FAISS index from the [rag] extra and a Lemonade-served embedding model, so listing both as prerequisites is correct, and both new anchor links resolve.

One thing to fix before merge: the new "Example files … under examples/" bullet doesn't match reality — this guide doesn't point readers at any files in that folder (the "examples" it mentions are inline chat snippets), and there's no memory example in examples/. Either drop the bullet or reword it so it doesn't promise files that aren't there.

🔍 Technical details

Verified accurate:

  • #for-developers and #manual-install both resolve to real headings in docs/quickstart.mdx (## For developers, ### Manual Install).
  • [rag] ships faiss-cpu (setup.py:232), and src/gaia/agents/base/memory.py:16,304 confirms memory uses a FAISS index — so "[rag] provides the FAISS index used for memory recall" is correct.
  • Lemonade-required claim holds: recall embeds via a Lemonade-served model (memory.py:15,150nomic-embed-text-v2-moe-GGUF).

🟢 Minor — "Example files" bullet is inaccurate (docs/guides/memory.mdx:36). The guide references no files under examples/; every "example" in it is an inline conversation snippet or a table cell ("code examples", "Example knowledge"), and there's no memory sample in the repo's examples/ dir. Suggest removing the bullet:

- **Lemonade server** must be running before you start:

  ```bash
  lemonade-server serve

(i.e. end the list at the Lemonade item; drop the trailing `examples/` bullet). If you'd rather keep a pointer, reword it to name an actual file — but none currently exists for memory.

**Strengths**
- Mirrors the established `docs/guides/code.mdx` prerequisites pattern (clone → uv venv → editable install → start Lemonade), keeping the guides consistent.
- Pins `--python 3.12` and shows the Windows activate path — small touches that prevent first-run friction.
- Scopes itself to one guide for feedback before fanning out to the rest of #1077; sensible incremental approach.
</details>

@itomek itomek enabled auto-merge June 26, 2026 14:34
@itomek itomek added this pull request to the merge queue Jun 26, 2026
Merged via the queue into amd:main with commit 0a4e2e1 Jun 26, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants