Skip to content

docs: add FAQ section#932

Open
meichuanyi wants to merge 1 commit into
AIGNE-io:mainfrom
meichuanyi:main
Open

docs: add FAQ section#932
meichuanyi wants to merge 1 commit into
AIGNE-io:mainfrom
meichuanyi:main

Conversation

@meichuanyi

Copy link
Copy Markdown

Summary

Added a comprehensive FAQ section to help users understand AIGNE Framework better.

Changes

  • Added FAQ section covering:
    • What "AIGNE" means and pronunciation
    • How AIGNE differs from other agent frameworks (LangChain, CrewAI)
    • Supported AI models (OpenAI, Anthropic, Gemini, DeepSeek, Ollama, OpenRouter)
    • Available workflow patterns (sequential, concurrent, router, handoff, reflection, code execution, group chat)
    • What Agentic File System (AFS) is and how to use it
    • MCP integration methods
    • Code execution safety with sandbox
    • Deployment options (Blocklet ecosystem or self-hosted)
    • Help resources (documentation, community forum, examples)

Why

FAQ sections help new users quickly find answers to common questions without reading through the entire documentation. This reduces onboarding friction and improves user experience.

Testing

  • FAQ placed before "Contributing and Releasing" section
  • All links verified and point to existing documentation
  • Content aligns with existing README structure and tone

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