docs: add volcengine voice quickstart tutorial for EMQX AI #3270
+703
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive tutorial for building AI voice agent with EMQ + Volcengine RTC: - Tutorial document with step-by-step setup instructions - Architecture overview and component explanations - Environment configuration guides (app, volc-server, web) - Feature verification steps with screenshots placeholders - Troubleshooting section for common issues - Update dir.yaml to include new tutorial section The tutorial demonstrates MCP over MQTT protocol implementation with: - Real-time voice interaction via Volcengine RTC/ASR/TTS - Device control capabilities (camera, expressions, volume) - CustomLLM integration with AI Agent service
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive Chinese-language tutorial for building an AI voice agent using EMQ, EMQX AI, and Volcengine's RTC services. The tutorial demonstrates the MCP over MQTT protocol implementation with real-time voice interaction and device control capabilities.
Key Changes:
- Comprehensive 630-line tutorial document with step-by-step setup instructions
- Architecture overview explaining the web, app, and volc-server components
- Detailed configuration guides for LLM API keys, MQTT broker, and Volcengine credentials
- Troubleshooting section and common issues documentation
Reviewed changes
Copilot reviewed 2 out of 7 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
zh_CN/emqx-ai/tutorials/quickstart-volcengine-voice.md |
New comprehensive tutorial covering AI voice agent setup with EMQ + Volcengine RTC, including architecture, environment configuration, feature verification, and troubleshooting |
dir.yaml |
Added new "Tutorials" section to navigation with reference to the new quickstart guide, plus minor whitespace cleanup |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove TODO comments for screenshots - Fix protocol naming: change "MQTT over MCP" to "MCP over MQTT" - Clean up documentation formatting
jinfahua
reviewed
Dec 3, 2025
Add English version of the quick start guide for building AI agents with EMQ + Volcengine voice services. The English doc provides: - Architecture overview and component descriptions - Prerequisites summary with references to Chinese version for details - Quick tutorial overview - Troubleshooting reference This resolves the CI failure caused by missing English translation.
Add Japanese placeholder document for the EMQX AI tutorial, referencing the Chinese version for detailed instructions. This completes the multi-language requirement for CI validation.
- Simplify security warning for key generation - Add security tip for .env files in git
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add comprehensive tutorial for building AI voice agent with EMQ + Volcengine RTC:
The tutorial demonstrates MCP over MQTT protocol implementation with: