Docs: Creation of new LlamaIndex Integration Guide#1098
Open
SarahScargall wants to merge 1 commit intoMemMachine:mainfrom
Open
Docs: Creation of new LlamaIndex Integration Guide#1098SarahScargall wants to merge 1 commit intoMemMachine:mainfrom
SarahScargall wants to merge 1 commit intoMemMachine:mainfrom
Conversation
Signed-off-by: Sarah Scargall <sarah.scargall@memverge.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.
Purpose of the change
This PR introduces the official LlamaIndex integration guide to the documentation site. It migrates the existing technical instructions from the repository into a high-quality, Mintlify-formatted
.mdxpage, ensuring developers have a clear path to implementing persistent memory within LlamaIndex chat engines.Description
Converted the
examples/llamaindex/guide.mdinto a structured, production-ready documentation page.memmachine-clientinstead of the legacymemmachinepackage name to align with the current renaming effort.<Steps>for initialization flow and<Note>for technical best practices.introduction.mdxlanding page.Dependencies: Requires
memmachine-clientandllama-index.Fixes/Closes
Fixes #1041
Type of change
How Has This Been Tested?
Test Steps:
.mdxfile renders correctly via Mintlify, ensuring the table formatting and<Steps>components are visually sound.memmachine-clientinstallation command is accurate for the current repository state.MemMachineMemoryinitialization parameters in the code snippets match the environment variables listed in the configuration table.Test Results: Documentation is consistent with the
guide.mdsource logic.Checklist
Maintainer Checklist
Screenshots/Gifs
Screenshot 1: LlamaIndex.mdx (1 of 3):

Screenshot 2: LlamaIndex.mdx (2 of 3):

Screenshot 3: LlamaIndex.mdx (3 of 3):

Screenshot 4: introduction.mdx showing our updated Integrations Cards Including LlamaIndex (1 of 1):

Further comments
Note for reviewers: The choice to use
memmachine-clientin thepip installinstructions is intentional to support the ongoing package renaming effort.