Skip to content

docs: Add FAQ section#2164

Open
meichuanyi wants to merge 2 commits into
TEN-framework:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section#2164
meichuanyi wants to merge 2 commits into
TEN-framework:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Adds a comprehensive FAQ section to README covering TEN Framework concepts, comparison with LangChain/CrewAI, TEN Agent Examples, LLM/ASR/TTS providers, TEN Ecosystem, Quick Start guide, deployment options, real-time voice handling, embedded device support (ESP32), and troubleshooting.

Changes

  • Added ## FAQ section before ## Questions
  • Updated Table of Contents with FAQ link
  • Covers 10+ FAQ topics with tables and code examples

Test plan:

  • README renders correctly on GitHub
  • All internal links work
  • FAQ content is accurate based on README and docs

Add comprehensive FAQ section covering:
- What is TEN Framework and its core features
- Core components overview (Framework, Agent Examples, VAD, Turn Detection, Portal)
- Quick start options (Codespaces, Docker, manual)
- Supported LLM/TTS/STT providers
- Voice assistant customization guide
- Local deployment without cloud services
- Production deployment options
- Comparison with other agent frameworks (LangChain, CrewAI)
- Community support channels

This helps new users quickly understand the framework and find
answers to common questions without searching through documentation.
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