Skip to content

docs: add FAQ section for common questions#53

Open
meichuanyi wants to merge 1 commit into
fdueblab:masterfrom
meichuanyi:docs/add-faq-v2
Open

docs: add FAQ section for common questions#53
meichuanyi wants to merge 1 commit into
fdueblab:masterfrom
meichuanyi:docs/add-faq-v2

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

This PR adds a comprehensive FAQ section to the README, covering:

  • General: Platform overview, differences from LangChain/CrewAI
  • Installation & Setup: pip install, Python version, LLM configuration
  • LLM Providers: Supported models, local model usage
  • Skills & Memory: Skill system, custom Skill creation, memory providers
  • RAG Retrieval: Knowledge base setup, retriever backends
  • MCP Tools: MCP server configuration, built-in tools
  • API Service: FastAPI deployment, endpoint features
  • Troubleshooting: Common issues and solutions

Why

Users often have common questions about:

  1. How Micro-Agent differs from existing frameworks
  2. Which LLM providers are supported
  3. How Skills and memory system work
  4. RAG knowledge base setup
  5. MCP tool configuration

This FAQ addresses these questions directly, improving the onboarding experience for vertical domain applications.

Checklist

  • Documentation added/updated
  • No code changes (documentation only)

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