Skip to content

docs: 更新文档部分图片#8765

Open
lingyun14beta wants to merge 27 commits into
AstrBotDevs:masterfrom
lingyun14beta:docs-image2
Open

docs: 更新文档部分图片#8765
lingyun14beta wants to merge 27 commits into
AstrBotDevs:masterfrom
lingyun14beta:docs-image2

Conversation

@lingyun14beta

@lingyun14beta lingyun14beta commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Related #8745

更新文档图片

文档中图片暂使用 GitHub 自动生成的链接,合并后需手动转存至 R2。

  • This is NOT a breaking change. / 这不是一个破坏性变更。

Screenshots or Test Results / 运行截图或测试结果


Checklist / 检查清单

  • 😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
    / 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。

  • 👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
    / 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”

  • 🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in requirements.txt and pyproject.toml.
    / 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到 requirements.txtpyproject.toml 文件相应位置。

  • 😮 My changes do not introduce malicious code.
    / 我的更改没有引入恶意代码。

Summary by Sourcery

Update documentation screenshots and align terminology with current AstrBot UI.

Documentation:

  • Replace legacy hosted images with new GitHub-hosted screenshots across English and Chinese docs.
  • Adjust provider and model configuration terminology to match updated UI labels (e.g., Default Chat Model → Default Conversation Model, Streaming Reply → Streaming Output).

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 13, 2026
@lingyun14beta lingyun14beta changed the title Docs image2 docs: 更新文档部分图片 Jun 13, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The new <img> tags all use alt="image", which regresses from the more descriptive alt texts in some of the original markdown images; consider restoring meaningful alt descriptions to keep the docs accessible and searchable.
  • Hard-coding width/height (often 1910x883) on the new <img> elements may hurt responsiveness on smaller screens; you may want to rely on markdown-style images or use CSS/responsive attributes instead of fixed dimensions.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new `<img>` tags all use `alt="image"`, which regresses from the more descriptive alt texts in some of the original markdown images; consider restoring meaningful alt descriptions to keep the docs accessible and searchable.
- Hard-coding width/height (often `1910x883`) on the new `<img>` elements may hurt responsiveness on smaller screens; you may want to rely on markdown-style images or use CSS/responsive attributes instead of fixed dimensions.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation by replacing Markdown image syntax with HTML tags containing explicit dimensions across multiple English and Chinese files, and refines some terminology (e.g., updating 'Streaming Reply' to 'Streaming Output'). The review feedback highlights opportunities to improve accessibility and SEO by preserving descriptive alt attributes instead of using generic 'image' placeholders. Additionally, it suggests updating the alt text in wecom_ai_bot.md to match the new terminology and unifying the term '默认聊天模型' to '默认对话模型' in siliconflow.md for consistency.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Navigate to the messaging platform, click to add a new adapter, find Discord and click to enter the Discord configuration page.

![Click to create bot, select discord type](https://files.astrbot.app/docs/source/images/discord/image.png)
<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/dea8c9f6-c870-428d-ab8c-379382d8a761" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

将图片替换为 <img> 标签时,原有的描述性 alt 属性(Click to create bot, select discord type)被替换为了通用的 alt="image"。为了保证文档的可访问性(Accessibility)和 SEO 友好性,建议保留原有的描述性 alt 文本。

Suggested change
<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/dea8c9f6-c870-428d-ab8c-379382d8a761" />
<img width="1910" height="883" alt="Click to create bot, select discord type" src="https://github.com/user-attachments/assets/dea8c9f6-c870-428d-ab8c-379382d8a761" />

进入机器人,点击新增适配器,找到 Discord 并点击进入 Discord 配置页。
> 旧版本`机器人``消息平台`
![点击创建机器人,选择discord类型](https://files.astrbot.app/docs/source/images/discord/image.png)
<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/b8f5842a-a186-4eeb-b8f8-9bce9d909a98" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

将图片替换为 <img> 标签时,原有的描述性 alt 属性(点击创建机器人,选择discord类型)被替换为了通用的 alt="image"。为了保证文档的可访问性和 SEO 友好性,建议保留原有的描述性 alt 文本。

Suggested change
<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/b8f5842a-a186-4eeb-b8f8-9bce9d909a98" />
<img width="1910" height="883" alt="点击创建机器人,选择discord类型" src="https://github.com/user-attachments/assets/b8f5842a-a186-4eeb-b8f8-9bce9d909a98" />

## 应用对话模型

在 AstrBot WebUI,点击左栏 `配置文件`,找到 AI 配置中的 `默认聊天模型`,选择刚刚创建的 `siliconflow`(硅基流动) 提供商,点击保存。 No newline at end of file
在 AstrBot WebUI,点击左栏 `配置文件`,找到 AI 配置中的 `默认聊天模型`,选择刚刚创建的 `siliconflow`(硅基流动) 提供商,点击保存。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

为了与 newapi.mdtokenpony.md 中的术语保持一致,建议将 默认聊天模型 统一修改为 默认对话模型

如果您需要类似实时打字机的效果,请确保在 AstrBot 中开启了 `流式回复` 功能。
如果您需要类似实时打字机的效果,请确保在 AstrBot 中开启了 `流式输出` 功能。

<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/fd962fba-eebd-448a-bf42-8d79c159c8c8" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

原有的描述性 alt 属性(流式回复)被替换为了通用的 alt="image"。由于正文已将 流式回复 更新为 流式输出,建议将图片的 alt 属性也更新为 流式输出,以保持一致性并提高文档的可访问性。

Suggested change
<img width="1910" height="883" alt="image" src="https://github.com/user-attachments/assets/fd962fba-eebd-448a-bf42-8d79c159c8c8" />
<img width="1910" height="883" alt="流式输出" src="https://github.com/user-attachments/assets/fd962fba-eebd-448a-bf42-8d79c159c8c8" />

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant