Skip to content

docs: Add FAQ section#65

Open
meichuanyi wants to merge 1 commit into
kingjulio8238:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section#65
meichuanyi wants to merge 1 commit into
kingjulio8238:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

This PR adds a comprehensive FAQ section to help users understand Memary concepts and troubleshoot common issues.

Changes

  • Added FAQ.md covering:

    • General: What is Memary, how it works, Memory Stream vs Entity Knowledge Store
    • Getting Started: Installation (pip/local), model support (Ollama/OpenAI), credentials setup
    • Features: Routing Agent, Knowledge Graphs, Multi-Graph, custom tools
    • Integration: ChatAgent usage, framework integration, user persona configuration
    • Configuration: Environment variables, local models, database setup (FalkorDB/Neo4j)
    • Troubleshooting: Install issues, Streamlit startup, KG search, Memory Stream updates
    • Help Resources: Documentation links, demo video, social media
  • Updated README.md to link the FAQ section

Why

Many users have questions about:

  • How Memary's memory system works (Memory Stream vs Entity Knowledge Store)
  • Setting up graph databases (FalkorDB/Neo4j)
  • Integrating with existing agent frameworks
  • Configuring local models via Ollama

This FAQ provides clear answers to help users get started quickly and understand Memary's unique memory layer architecture.

Testing

  • FAQ content validated against official documentation at memarydocs
  • All code examples tested against quick-start guide
  • Installation instructions verified with pip and local setup

… - General concepts (Memory Layer, Knowledge Graphs, Memory Modules)\n - Getting Started (installation, models, credentials)\n - Features (Routing Agent, Knowledge Graph, Multi-Graph, custom tools)\n - Integration (ChatAgent, other frameworks, user personas)\n - Configuration (environment, local models, databases)\n - Troubleshooting (install, streamlit, KG search, memory stream)\n - Help resources\n\n- Link FAQ in README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant