Skip to content

docs: 新增 BetterGI 脚本配置指南(中/英)并接入导航 - #22

Open
TCddddd wants to merge 1 commit into
AUTO-MAS-Project:masterfrom
TCddddd:feat/bettergi-docs
Open

docs: 新增 BetterGI 脚本配置指南(中/英)并接入导航#22
TCddddd wants to merge 1 commit into
AUTO-MAS-Project:masterfrom
TCddddd:feat/bettergi-docs

Conversation

@TCddddd

@TCddddd TCddddd commented Aug 23, 2026

Copy link
Copy Markdown

概述

新增 BetterGI 脚本配置指南(中/英),并接入文档站侧边栏与脚本指南索引。

变更

  • 新增 docs/script-guide/bettergi.md(中文)与 en/docs/script-guide/bettergi.md(英文)
  • 讲解配置管理方式、一条龙 8 个内置配置组开关语义、自定义配置组管理与「配置 BetterGI」原生设置会话
  • docs/script-guide/index.mden/docs/script-guide/index.md 加入 BetterGI 卡片与阅读建议
  • .vitepress/config/zh.tsconfig/en.ts 侧边栏在 HSR 后注册 BetterGI 入口

与主程序 PR:#410 配套。

Sourcery 摘要

新增双语 BetterGI 配置文档,并将其集成到脚本指南导航中。

文档:

  • 新增双语 BetterGI 配置指南,涵盖设置、配置模式、内置和自定义 One Dragon 组、本地设置会话以及按用户配置的行为。
  • 在中文和英文脚本指南索引中添加 BetterGI 指南链接,并将 BetterGI 条目添加到两个文档侧边栏中。
Original summary in English

Summary by Sourcery

Add bilingual BetterGI configuration documentation and integrate it into the script-guide navigation.

Documentation:

  • Add bilingual BetterGI configuration guides covering setup, configuration modes, built-in and custom One Dragon groups, native settings sessions, and per-user configuration behavior.
  • Link the BetterGI guides from the Chinese and English script-guide indexes and add BetterGI entries to both documentation sidebars.

- 新增 docs/script-guide/bettergi.md 与 en/docs/script-guide/bettergi.md
- 讲解配置管理方式、一条龙 8 个内置配置组开关语义、自定义配置组与原生设置会话
- 侧边栏与脚本指南索引加入 BetterGI 条目
@sourcery-ai

sourcery-ai Bot commented Aug 23, 2026

Copy link
Copy Markdown

审查者指南

新增双语 BetterGI 配置指南,并将其接入中文和英文网站的文档导航及脚本指南索引。

BetterGI 用户专属配置运行时序图

sequenceDiagram
    participant User
    participant MAS as AUTO-MAS
    participant BetterGI

    User->>MAS: Add user and configure One Dragon tasks
    MAS->>BetterGI: Load user's One Dragon copy before run
    BetterGI-->>MAS: Run configured tasks
    MAS->>BetterGI: Read back configuration after run
    MAS->>MAS: Save user's independent copy
Loading

BetterGI 原生设置会话时序图

sequenceDiagram
    participant User
    participant MAS as AUTO-MAS
    participant BetterGI

    User->>MAS: Click Configure BetterGI
    MAS->>BetterGI: Open native settings interface
    User->>BetterGI: Configure settings
    User->>MAS: Click Save Settings
    MAS->>BetterGI: Read current One Dragon configuration
    MAS->>MAS: Snapshot user's independent copy
Loading

BetterGI 配置管理模式流程图

flowchart LR
    Start[Select configuration management mode] --> Mode{Mode}
    Mode -->|User-specific config| UserConfig[Load and write back per-user One Dragon copy]
    Mode -->|Script direct control| DirectConfig[Use BetterGI current config directly]
    UserConfig --> Editable[Task and custom group settings editable]
    DirectConfig --> Locked[Task and custom group settings disabled]
Loading

文件级变更

变更 详细信息 文件
新增中英文 BetterGI 脚本配置详细文档,涵盖配置模式、内置/自定义分组以及 BetterGI 原生设置流程。
  • 创建中文 BetterGI 配置指南页面,包含 frontmatter,以及设置、配置模式、内置分组、自定义分组和常见问题等分步章节。
  • 创建英文 BetterGI 配置指南页面,以中文内容为基础,并适配英文术语和原神相关表述。
  • 记录 AUTO-MAS 对每位用户 One Dragon 配置的处理方式,包括存储路径、种子优先级,以及与 BetterGI 原生 JSON 配置的交互。
docs/script-guide/bettergi.md
en/docs/script-guide/bettergi.md
在两种语言的脚本指南索引页面和侧边栏导航中展示 BetterGI,方便用户从文档界面发现新指南。
  • 在中文脚本指南索引中添加 BetterGI 卡片/章节,包括简要功能概述以及面向原神玩家的推荐说明。
  • 在英文脚本指南索引中添加 BetterGI 卡片/章节,包含等效内容以及针对原神的定位说明。
  • 在中文和英文 VitePress 侧边栏配置中的脚本指南分组里,将 BetterGI 条目插入 HSR 之后。
docs/script-guide/index.md
en/docs/script-guide/index.md
.vitepress/config/zh.ts
.vitepress/config/en.ts

提示和命令

与 Sourcery 交互

  • 触发新的审查: 在拉取请求中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 根据审查评论生成 GitHub issue: 回复审查评论,请 Sourcery 根据该评论创建 issue。你也可以回复审查评论并使用 @sourcery-ai issue,以根据该评论创建 issue。
  • 生成拉取请求标题: 在拉取请求标题的任意位置写入 @sourcery-ai,即可随时生成标题。你也可以在拉取请求中评论 @sourcery-ai title,以随时(重新)生成标题。
  • 生成拉取请求摘要: 在拉取请求正文中你希望插入摘要的位置写入 @sourcery-ai summary,即可随时生成 PR 摘要。你也可以在拉取请求中评论 @sourcery-ai summary,以随时(重新)生成摘要。
  • 生成审查者指南: 在拉取请求中评论 @sourcery-ai guide,即可随时(重新)生成审查者指南。
  • 解决所有 Sourcery 评论: 在拉取请求中评论 @sourcery-ai resolve,即可解决所有 Sourcery 评论。如果你已经处理完所有评论且不想再看到它们,这项功能会很有用。
  • 忽略所有 Sourcery 审查: 在拉取请求中评论 @sourcery-ai dismiss,即可忽略所有现有的 Sourcery 审查。如果你想从新的审查开始,这项功能尤其有用——别忘了评论 @sourcery-ai review 来触发新的审查!

自定义你的使用体验

访问你的控制面板以:

  • 启用或禁用审查功能,例如 Sourcery 生成的拉取请求摘要、审查者指南等。
  • 更改审查语言。
  • 添加、删除或编辑自定义审查说明。
  • 调整其他审查设置。

获取帮助

Original review guide in English

Reviewer's Guide

Adds a bilingual BetterGI configuration guide and wires it into the docs navigation and script guide index for both Chinese and English sites.

Sequence diagram for BetterGI user-specific configuration run

sequenceDiagram
    participant User
    participant MAS as AUTO-MAS
    participant BetterGI

    User->>MAS: Add user and configure One Dragon tasks
    MAS->>BetterGI: Load user's One Dragon copy before run
    BetterGI-->>MAS: Run configured tasks
    MAS->>BetterGI: Read back configuration after run
    MAS->>MAS: Save user's independent copy
Loading

Sequence diagram for BetterGI native settings session

sequenceDiagram
    participant User
    participant MAS as AUTO-MAS
    participant BetterGI

    User->>MAS: Click Configure BetterGI
    MAS->>BetterGI: Open native settings interface
    User->>BetterGI: Configure settings
    User->>MAS: Click Save Settings
    MAS->>BetterGI: Read current One Dragon configuration
    MAS->>MAS: Snapshot user's independent copy
Loading

Flow diagram for BetterGI configuration management modes

flowchart LR
    Start[Select configuration management mode] --> Mode{Mode}
    Mode -->|User-specific config| UserConfig[Load and write back per-user One Dragon copy]
    Mode -->|Script direct control| DirectConfig[Use BetterGI current config directly]
    UserConfig --> Editable[Task and custom group settings editable]
    DirectConfig --> Locked[Task and custom group settings disabled]
Loading

File-Level Changes

Change Details Files
Introduce detailed BetterGI script configuration documentation in Chinese and English, covering configuration modes, built-in/custom groups, and native BetterGI setup flows.
  • Create a Chinese BetterGI configuration guide page with frontmatter and step-by-step sections for setup, configuration modes, built-in groups, custom groups, and FAQ.
  • Create an English BetterGI configuration guide page mirroring the Chinese content, adapted for English terminology and Genshin-specific wording.
  • Document AUTO-MAS’s per-user One Dragon config handling, including storage paths, seed priority, and interaction with BetterGI’s native JSON configs.
docs/script-guide/bettergi.md
en/docs/script-guide/bettergi.md
Expose BetterGI in the script guide index pages and sidebar navigation for both locales so users can discover the new guide from the docs UI.
  • Add a BetterGI card/section to the Chinese script-guide index, including a brief feature summary and a recommendation line for Genshin players.
  • Add a BetterGI card/section to the English script-guide index with equivalent content and Genshin-specific positioning.
  • Insert BetterGI entries into the Chinese and English VitePress sidebar configs immediately after HSR in the script-guide group.
docs/script-guide/index.md
en/docs/script-guide/index.md
.vitepress/config/zh.ts
.vitepress/config/en.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

你好——我发现了 1 个问题

面向 AI Agent 的提示
请处理本次代码审查中的评论:

## 单独评论

### 评论 1
<location path="en/docs/script-guide/bettergi.md" line_range="57" />
<code_context>
+| 3 | Auto Ley Line Outcrop |
+| 4 | Auto Domain |
+| 5 | Auto world boss hunting |
+| 6 | Auto Arcalanos crisis war |
+| 7 | Claim daily rewards |
+| 8 | Claim Serenitea Pot rewards |
</code_context>
<issue_to_address>
**问题:** 英文指南将第六个内置组标记为“Auto Arcalanos crisis war”,但这并不是《原神》活动「幽境危战」的英文名称,也不符合 BetterGI 中任何可识别的设置。英语用户无法可靠地判断该行控制的是哪个开关。

**触发条件:** 英语用户配置第六个内置组时。

**建议修复:** 使用该活动的官方英文名称,例如“Auto Stygian Onslaught”,或在翻译旁保留中文名称。

```suggestion
| 6 | Auto Stygian Onslaught |
```
</issue_to_address>

Sourcery 评估

等待批准。 请先处理 1 个发现的问题。

阻塞性发现:en/docs/script-guide/bettergi.md:57


Sourcery 对开源项目免费——如果您喜欢我们的审查结果,请考虑分享它们 ✨
帮助我变得更有用!请在每条评论上点击 👍 或 👎,我会利用反馈来改进审查结果。
Original comment in English

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="en/docs/script-guide/bettergi.md" line_range="57" />
<code_context>
+| 3 | Auto Ley Line Outcrop |
+| 4 | Auto Domain |
+| 5 | Auto world boss hunting |
+| 6 | Auto Arcalanos crisis war |
+| 7 | Claim daily rewards |
+| 8 | Claim Serenitea Pot rewards |
</code_context>
<issue_to_address>
**issue:** The English guide labels the sixth built-in group as “Auto Arcalanos crisis war,” which is not the English name of the Genshin Impact activity 「幽境危战」 and does not match a recognizable BetterGI setting. English-speaking users cannot reliably identify which toggle this row controls.

**Triggers:** When an English-speaking user configures the sixth built-in group.

**Suggested fix:** Use the activity's official English name, such as “Auto Stygian Onslaught,” or retain the Chinese name alongside the translation.

```suggestion
| 6 | Auto Stygian Onslaught |
```
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: en/docs/script-guide/bettergi.md:57


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.

| 3 | Auto Ley Line Outcrop |
| 4 | Auto Domain |
| 5 | Auto world boss hunting |
| 6 | Auto Arcalanos crisis war |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

问题: 英文指南将第六个内置组标记为“Auto Arcalanos crisis war”,但这并不是《原神》活动「幽境危战」的英文名称,也不符合 BetterGI 中任何可识别的设置。英语用户无法可靠地判断该行控制的是哪个开关。

触发条件: 英语用户配置第六个内置组时。

建议修复: 使用该活动的官方英文名称,例如“Auto Stygian Onslaught”,或在翻译旁保留中文名称。

Suggested change
| 6 | Auto Arcalanos crisis war |
| 6 | Auto Stygian Onslaught |
Original comment in English

issue: The English guide labels the sixth built-in group as “Auto Arcalanos crisis war,” which is not the English name of the Genshin Impact activity 「幽境危战」 and does not match a recognizable BetterGI setting. English-speaking users cannot reliably identify which toggle this row controls.

Triggers: When an English-speaking user configures the sixth built-in group.

Suggested fix: Use the activity's official English name, such as “Auto Stygian Onslaught,” or retain the Chinese name alongside the translation.

Suggested change
| 6 | Auto Arcalanos crisis war |
| 6 | Auto Stygian Onslaught |

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant