docs: add Prerequisites block to memory guide#1665
Conversation
|
Hi @kovtcharov! This is my first guide update for #1077. |
|
@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? |
|
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 ( Quickstart already splits these audiences (
One accuracy note in your favor, @somo9909: the 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. |
|
Hi @somo9909, can you comment when this PR will be ready for review? |
itomek
left a comment
There was a problem hiding this comment.
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):
- 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]). - The edit dropped the file's trailing newline (
\ No newline at end of filein 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! 🎉
itomek
left a comment
There was a problem hiding this comment.
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. 🎉
|
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, One thing to fix before merge: the new "Example files … under 🔍 Technical detailsVerified accurate:
🟢 Minor — "Example files" bullet is inaccurate ( |
Contributes to #1077
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:
Notes
Starting with memory.mdx first for feedback before
updating the remaining 13 guides.