Skip to content

docs(readme): 优化样式并添加多语言版本 - #32

Merged
yororoA merged 2 commits into
mainfrom
docs/readme-style
Sep 29, 2026
Merged

yororoA merged 2 commits into
mainfrom
docs/readme-style

Conversation

@yororoA

@yororoA yororoA commented Sep 29, 2026 •

Copy link
Copy Markdown
Owner

概要

  • 重构 README 首屏,增加品牌图标、状态徽章、快捷导航和迁移流程图
  • 使用 GitHub 原生提示块强化兼容性与隐私边界
  • 新增英语、日语、德语、俄语和繁体中文 README,并提供统一语言切换入口
  • 重整文档索引,提升长文档的可扫描性
  • 更新 npm 包校验,确保所有本地化 README 随包发布

验证

  • npm run check(480 项测试通过,lint、类型检查、构建与 smoke test 通过)
  • npm run verify:package
  • npx --yes markdownlint-cli2 'README*.md'
  • 校验全部 README 的本地链接与语言互链

Summary by Sourcery

Redesign the README documentation and add multilingual versions to make migration guidance clearer and more accessible.

New Features:

  • Add English, Japanese, German, Russian, and Traditional Chinese README translations with consistent language navigation.
  • Add a redesigned README landing section with branding, status badges, quick links, migration flow diagrams, and structured compatibility guidance.

Enhancements:

  • Improve README organization and scanability with clearer migration steps, GitHub alert blocks, compatibility explanations, privacy boundaries, and documentation indexes.
  • Include localized README files in package artifact verification and required-file checks.

Documentation:

  • Expand the project’s user-facing README documentation across six languages while keeping links and navigation consistent.

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

Sorry @yororoA, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 20 hours and 56 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Sep 29, 2026

Copy link
Copy Markdown

Reviewer's Guide

本 PR 以统一的首屏结构重写 README,使用图标、徽章、导航、流程图和 GitHub 提示块提升可读性,并新增英语、日语、德语、俄语及繁体中文版本;所有版本同步展示迁移流程、兼容性、安全边界和文档索引,同时已通过测试、类型检查、Markdown 校验及本地链接互链验证。

Flow diagram for the documented TRAE to OpenCode migration

flowchart LR
    A["TRAE session<br>Read-only extraction"] --> B["Export and redact<br>Migration Bundle"]
    B --> C["Map OpenCode v1 / v2 protocol"]
    C --> D["Native import"]
    D --> E["Read back and reconcile<br>content and hashes"]
Loading

File-Level Changes

Change Details Files
重构中文 README 首屏并重新组织长文档导航,突出迁移流程、兼容性和隐私安全边界。
  • 加入品牌图标、CI/版本/运行环境/许可证徽章及快捷导航
  • 将迁移步骤和数据流改为表格、Mermaid 流程图与 GitHub 原生提示块
  • 将文档链接重整为按主题分类的索引表
README.md
新增五种语言的完整 README,并通过一致的语言切换入口相互关联。
  • 新增英语、日语、德语、俄语和繁体中文版本
  • 在各语言版本中同步迁移命令、兼容性要求、限制、隐私说明和故障排查内容
  • 为每个版本提供本地文档链接、快捷导航和统一语言选择器
README.en.md
README.ja.md
README.de.md
README.ru.md
README.zh-Hant.md

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

@yororoA
yororoA merged commit 304b7c2 into main Sep 29, 2026
14 checks passed
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