Skip to content

Docs: Creation of new LlamaIndex Integration Guide#1098

Open
SarahScargall wants to merge 1 commit intoMemMachine:mainfrom
SarahScargall:llamaindex
Open

Docs: Creation of new LlamaIndex Integration Guide#1098
SarahScargall wants to merge 1 commit intoMemMachine:mainfrom
SarahScargall:llamaindex

Conversation

@SarahScargall
Copy link
Contributor

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 .mdx page, ensuring developers have a clear path to implementing persistent memory within LlamaIndex chat engines.

Description

Converted the examples/llamaindex/guide.md into a structured, production-ready documentation page.

  • Renaming Alignment: Updated all installation and import references to use memmachine-client instead of the legacy memmachine package name to align with the current renaming effort.
  • Component Implementation: Leveraged <Steps> for initialization flow and <Note> for technical best practices.
  • Standardization: Updated the configuration tables to use consistent terminology (org_id, project_id, user_id) to match other framework guides.
  • Integration Discovery: Added the LlamaIndex card to the main introduction.mdx landing page.

Dependencies: Requires memmachine-client and llama-index.

Fixes/Closes

Fixes #1041

Type of change

  • Documentation update

How Has This Been Tested?

  • Manual verification (list step-by-step instructions)

Test Steps:

  1. Rendering Check: Verified the .mdx file renders correctly via Mintlify, ensuring the table formatting and <Steps> components are visually sound.
  2. Technical Verification: Validated that the memmachine-client installation command is accurate for the current repository state.
  3. Snippet Review: Confirmed that the MemMachineMemory initialization parameters in the code snippets match the environment variables listed in the configuration table.

Test Results: Documentation is consistent with the guide.md source logic.

Checklist

  • I have signed the commit(s) within this pull request
  • My code follows the style guidelines of this project (See STYLE_GUIDE.md)
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • Confirmed all checks passed
  • Contributor has signed the commit(s)
  • Reviewed the code
  • Run, Tested, and Verified the change(s) work as expected

Screenshots/Gifs

Screenshot 1: LlamaIndex.mdx (1 of 3):
Screenshot 2026-02-10 at 4 21 12 PM

Screenshot 2: LlamaIndex.mdx (2 of 3):
Screenshot 2026-02-10 at 4 21 46 PM

Screenshot 3: LlamaIndex.mdx (3 of 3):
Screenshot 2026-02-10 at 4 22 26 PM

Screenshot 4: introduction.mdx showing our updated Integrations Cards Including LlamaIndex (1 of 1):
Screenshot 2026-02-10 at 4 23 39 PM

Further comments

Note for reviewers: The choice to use memmachine-client in the pip install instructions is intentional to support the ongoing package renaming effort.

Signed-off-by: Sarah Scargall <sarah.scargall@memverge.com>
@SarahScargall SarahScargall added the documentation Issues related to documentation label Feb 10, 2026
Copy link
Contributor

@sscargal sscargal left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Create new Integration Guide for LlamaIndex

2 participants