docs: update quick start guide with architecture and packaging sections#1252
Merged
MistEO merged 7 commits intoMaaXYZ:mainfrom Apr 18, 2026
Merged
docs: update quick start guide with architecture and packaging sections#1252MistEO merged 7 commits intoMaaXYZ:mainfrom
MistEO merged 7 commits intoMaaXYZ:mainfrom
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些整体性的反馈：
- 请再次检查你新增的图片和链接路径（例如：
/docs/static/architecture.png、/README_en.md#general-ui）是否正确，并且与其他文档引用静态资源和 README 的方式保持一致（相对路径 vs 绝对路径），以确保它们在所有构建/部署环境中都能正确渲染。
给 AI 代理的提示
Please address the comments from this code review:
## Overall Comments
- Double-check the new image and link paths (e.g., `/docs/static/architecture.png`, `/README_en.md#general-ui`) are correct and consistent with how other docs reference static assets and the README (relative vs absolute paths) so they render properly in all build/deploy contexts.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的评审。
Original comment in English
Hey - I've left some high level feedback:
- Double-check the new image and link paths (e.g.,
/docs/static/architecture.png,/README_en.md#general-ui) are correct and consistent with how other docs reference static assets and the README (relative vs absolute paths) so they render properly in all build/deploy contexts.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Double-check the new image and link paths (e.g., `/docs/static/architecture.png`, `/README_en.md#general-ui`) are correct and consistent with how other docs reference static assets and the README (relative vs absolute paths) so they render properly in all build/deploy contexts.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
neko-para
requested changes
Apr 12, 2026
Contributor
Author
|
@neko-para 修了 |
neko-para
approved these changes
Apr 12, 2026
| @@ -1,5 +1,13 @@ | |||
| # 1.1 快速开始 | |||
|
|
|||
| 一个基于 MaaFramework 开发项目通常包含`MaaFramework本体`、`UI`、`项目资源`、`agent`几个部分。其中，`项目资源`定义做什么，`本体`负责执行，`agent`用于扩展自定义逻辑，`UI`提供交互界面并通过[ProjectInterface协议](./3.3-ProjectInterfaceV2协议.md)读取资源和进行操作。 | |||
MistEO
reviewed
Apr 12, 2026
| @@ -1,5 +1,13 @@ | |||
| # 1.1 快速开始 | |||
|
|
|||
| 一个基于 MaaFramework 开发项目通常包含`MaaFramework本体`、`UI`、`项目资源`、`agent`几个部分。其中，`项目资源`定义做什么，`本体`负责执行，`agent`用于扩展自定义逻辑，`UI`提供交互界面并通过[ProjectInterface协议](./3.3-ProjectInterfaceV2协议.md)读取资源和进行操作。 | |||
Member
There was a problem hiding this comment.
感觉不太对，一上来说这个，没接触过的小白更听不懂了，不要一上来就抛出一堆概念
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary by Sourcery
更新快速入门指南，为基于 MaaFramework 的项目添加高层架构背景和打包说明。
文档：
Original summary in English
Summary by Sourcery
Update the Quick Start guide with high-level architecture context and packaging instructions for MaaFramework-based projects.
Documentation: