docs: Add FAQ section for common questions#8278
Conversation
dosubot
Bot
added
the
size:M
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request updates project badges and adds a new FAQ section to the README. Feedback focuses on maintaining consistency by synchronizing these updates across localized README files and ensuring the FAQ content aligns with existing information regarding supported features and LLM providers.
|
|
||
| <div> | ||
| <a href="https://trendshift.io/repositories/12875" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12875" alt="Soulter%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> | ||
| <a href="https://trendshift.io/repositories/21369" target="_blank"><img src="https://trendshift.io/api/badge/repositories/21369" alt="AstrBotDevs%2FAstrBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> |
There was a problem hiding this comment.
The repository ID and name in the Trendshift badge have been updated here, but they remain unchanged in the localized README files (e.g., README_zh.md line 12, README_ja.md line 14). Additionally, the contributor badge parameters on line 261 have been updated only in this file. Please synchronize these changes across all README versions to ensure consistent branding and statistics.
| <img src="https://files.astrbot.app/watashiwa-koseino-desukara.gif" width="100"/> | ||
| </div> | ||
|
|
||
| ## FAQ (Frequently Asked Questions) |
There was a problem hiding this comment.
This new FAQ section provides valuable information but is currently only added to the English README. To ensure that users of all supported languages benefit from this content, please consider adding and translating this section in the localized README files (README_zh.md, README_ja.md, etc.).
| ### Key Features | ||
|
|
||
| | Feature | Description | | ||
| |---------|-------------| | ||
| | 🆓 Free & Open Source | MIT-licensed, community-driven | | ||
| | 🤖 AI Conversations | LLM, multimodal, Agent, MCP, Skills, Knowledge Base | | ||
| | 🌐 Multi-Platform | QQ, WeChat Work, Feishu, DingTalk, Telegram, Slack | | ||
| | 📦 1000+ Plugins | One-click installation | | ||
| | 🛡️ Agent Sandbox | Safe code execution | | ||
| | 💻 WebUI & ChatUI | Web interfaces | | ||
|
|
||
| ### Getting Started | ||
|
|
||
| ```bash | ||
| uv tool install astrbot --python 3.12 | ||
| astrbot init | ||
| astrbot run | ||
| ``` | ||
|
|
||
| ### LLM Providers | ||
|
|
||
| OpenAI, Anthropic, Google Gemini, DeepSeek, Alibaba Cloud Bailian, Moonshot, MiniMax, StepFun, Ollama, vLLM. |
There was a problem hiding this comment.
The 'Key Features' table and 'LLM Providers' list in this FAQ section are inconsistent with the main sections of the README. For example, the features table (line 300) omits 'WeChat Official Accounts' (listed on line 49), and the LLM list (line 315) contains providers like StepFun and vLLM that are missing from the main 'Supported Model Services' table (lines 173-188). Please ensure the FAQ accurately reflects the full capabilities and integrations described elsewhere in the document.
1 participant
Summary
Added a comprehensive FAQ section to help users quickly understand the project and get started.
FAQ Content
Checklist
Summary by Sourcery
Documentation: