docs: Add FAQ section for common questions

[meichuanyi]

Summary

Adds a comprehensive FAQ section covering:

• What is Evo AI - Open-source AI agent platform overview
• Agent Types table - 7 agent types with descriptions and use cases
• Tech Stack Overview table - Backend/Frontend/Observability layers
• Prerequisites Summary table - Backend/Frontend/Production requirements
• Installation Methods - Manual/Docker Compose/Docker Frontend Only options
• Langfuse Integration - Observability setup via OpenTelemetry
• A2A Protocol Support - Google Agent 2 Agent interoperability
• Free Policy - Apache 2.0 License + contribution info
• Help Resources table - Docs/Discord/WhatsApp/Postman/Issues/A2A links

Checklist

• Documentation update only
• FAQ specific to Evo AI platform features
• Tables for agent types/tech stack/prerequisites
• All external links verified

Testing

• README renders correctly
• FAQ section positioned before License section
• All links are valid

Summary by Sourcery

Add a new FAQ section to the README to explain Evo AI and provide quick-reference information for users.

Documentation:

• Document Evo AI’s purpose and capabilities as an open-source AI agent platform in a new FAQ section.
• Add tables summarizing available agent types, the tech stack, and prerequisites for backend, frontend, and production use.
• Document supported installation methods, Langfuse-based observability, A2A protocol support, licensing, and key help resources in the README FAQ.

[sourcery-ai]

Reviewer's Guide

Adds a new FAQ section to the README that explains what Evo AI is, outlines supported agent types, summarizes the tech stack and prerequisites, documents installation options, and highlights Langfuse, A2A protocol support, licensing, and help resources.

File-Level Changes

Change	Details	Files
Add FAQ section describing Evo AI, supported agent types, tech stack, prerequisites, installation methods, observability, protocol support, licensing, and help resources.	Inserted a new FAQ heading positioned immediately before the License section in the README. Documented a high-level description of Evo AI, including supported AI models, MCP servers, and A2A protocol integration. Added a markdown table listing available agent types, with brief descriptions and example use cases. Added a tech stack overview table covering backend, frontend, and observability technologies used by the platform. Added a prerequisites summary table listing backend, frontend, and production environment requirements. Documented three installation methods (manual, Docker Compose, Docker frontend-only) in a concise steps table. Documented Langfuse integration using OpenTelemetry, including required environment variables for tracing. Added a short section explaining A2A protocol support and its role in cross-agent interoperability. Clarified that Evo AI is free and open-source under Apache 2.0 with a pointer to contributing guidelines. Added a help resources table with links to docs, community channels, Postman collection, GitHub issues, and A2A protocol docs.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The project name alternates between EvoAI and Evo AI in the README; consider standardizing to a single spelling to avoid confusion and make search/discovery easier.
• Several FAQ sections (tech stack, prerequisites, installation methods) partially duplicate existing README content; you might want to link to or reuse those sections instead to reduce future drift between the tables and the detailed setup instructions.
• In the Langfuse integration section, double-check that the listed environment variable names and expected values (e.g., LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, OTEL_EXPORTER_OTLP_ENDPOINT) match the actual .env / configuration keys used in the codebase to prevent confusion for users following the FAQ.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The project name alternates between `EvoAI` and `Evo AI` in the README; consider standardizing to a single spelling to avoid confusion and make search/discovery easier.
- Several FAQ sections (tech stack, prerequisites, installation methods) partially duplicate existing README content; you might want to link to or reuse those sections instead to reduce future drift between the tables and the detailed setup instructions.
- In the Langfuse integration section, double-check that the listed environment variable names and expected values (e.g., `LANGFUSE_PUBLIC_KEY`, `LANGFUSE_SECRET_KEY`, `OTEL_EXPORTER_OTLP_ENDPOINT`) match the actual `.env` / configuration keys used in the codebase to prevent confusion for users following the FAQ.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}