Skip to content

docs: Add FAQ section for common questions #8278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
meichuanyi wants to merge 1 commit into from
+41 −2
Closed

docs: Add FAQ section for common questions #8278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<br>

<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>
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

<a href="https://hellogithub.com/repository/AstrBotDevs/AstrBot" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=d127d50cd5e54c5382328acc3bb25483&claim_uid=ZO9by7qCXgSd6Lp&t=2" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
</div>

Expand Down Expand Up @@ -258,7 +258,7 @@ pre-commit install
Special thanks to all Contributors and plugin developers for their contributions to AstrBot ❤️

<a href="https://github.com/AstrBotDevs/AstrBot/graphs/contributors">
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot&max=200&columns=14" />
<img src="https://contrib.rocks/image?repo=AstrBotDevs/AstrBot&max=300&columns=15" />
</a>

Additionally, the birth of this project would not have been possible without the help of the following open-source projects:
Expand All @@ -284,3 +284,42 @@ _私は、高性能ですから!_

<img src="https://files.astrbot.app/watashiwa-koseino-desukara.gif" width="100"/>
</div>

## FAQ (Frequently Asked Questions)
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.).


### What is AstrBot?

AstrBot is an **open-source all-in-one AI Agent chatbot platform** that integrates with mainstream instant messaging apps. It provides reliable and scalable conversational AI infrastructure for individuals, developers, and teams.

### 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.
Comment on lines +294 to +315
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.


### License

MIT License.

### Help Resources

- [Documentation](https://astrbot.app/)
- [Blog](https://blog.astrbot.app/)
- [Issues](https://github.com/AstrBotDevs/AstrBot/issues)