Skip to content

doc(readme): 同步中英文 README 并补充分支差异与 AI 支持说明 - #21

Merged
AlianBlank merged 1 commit into
mainfrom
feature/auto-luban-worker-run-87-20261024T0920
Oct 24, 2026
Merged

AlianBlank merged 1 commit into
mainfrom
feature/auto-luban-worker-run-87-20261024T0920

Conversation

@AlianBlank

@AlianBlank AlianBlank commented Oct 24, 2026 •

Copy link
Copy Markdown
Collaborator

Linear: GFX-997

Summary by CodeRabbit

  • 文档
    • 更新中文说明并新增英文版文档,介绍 GameFrameX 分支与上游版本的差异、保留的修复及相关工具用法。
    • 补充本地化文件生成规则、配置选项、Docker 镜像示例、文档链接和测试说明。
    • 更新 AI 工具、MCP、Skills、命令行及仓库资源的使用指南,并恢复支持与联系信息。

合并官方 v5.1.0 时 README.md 残留两处冲突标记,README_EN.md 在早期
被删除导致语言切换链接失效。本次解决冲突并以官方版为基础恢复英文
README,中英文章节一一对应。

新增 GameFrameX 分支说明(功能差异、自定义修复在合并后的存续状态)
与 AI 支持章节(MCP 配置、技能、schema-json、--errorFormat json),
补充 --excludePath 说明,按代码修正内联本地化合并语义,Docker 示例
改为版本占位,修正已失效的 whats-new 文档链接。

Linear: GFX-997
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

README.md 更新 GameFrameX 分支、AI 工具和使用配置说明。新增 README_EN.md,介绍 fork 功能、配置规则、Docker 使用及开发测试。

Changes: README 文档更新

Layer / File(s) Summary
分支说明与 AI 工具
README.md, README_EN.md
README.md 补充 GameFrameX 分支差异、AI 工具构建与使用说明。新增英文 README,介绍 fork、AI 能力及相关用法。
生成目标与导入、本地化说明
README.md
调整 split 与 LitJson 目标、本地化文件夹等英文说明。更新内联本地化重生成规则,并补充 --excludePath 的参数用法。
Docker 文档与文档整理
README.md
更新 Docker 版本示例和镜像内容说明,新增 5.x 文档链接,并清理重复内容及冲突标记。

Priority: Not assessed

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related issues

  • Issue 17:涉及同步更新中英文 README,补充 AI、MCP、Skills 和 GameFrameX 分支差异说明。
  • Issue 16:涉及 README 中记录的 GameFrameX 自定义修复及内联本地化行为。
  • Issue 15:要求补充 README、MCP 和 Skills 入口文档;本 PR 更新文档,但未执行发布。
  • Issue 12:涉及 README.md 和 README_EN.md 的合并冲突;本 PR 清理冲突标记并更新文档。

Possibly related PRs

  • GameFrameX/luban#19:该 PR 更新 README 中的 AI、Skills 和 MCP 说明;本 PR 的文档内容与其直接对应。

Suggested reviewers: pirunxi

Merge Risk: Low · up to c0238

MCP 配置说明可能让用户设置不需要的变量;建议按工具更正。该文档问题影响有限,不妨碍合并。

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AlianBlank
AlianBlank merged commit a8fe362 into main Oct 24, 2026
1 of 2 checks passed
@AlianBlank
AlianBlank deleted the feature/auto-luban-worker-run-87-20261024T0920 branch October 24, 2026 10:18
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