Skip to content

docs: fix zh README config template path#220

Open
MackDing wants to merge 1 commit into
xming521:masterfrom
MackDing:docs/fix-config-template-path
Open

docs: fix zh README config template path#220
MackDing wants to merge 1 commit into
xming521:masterfrom
MackDing:docs/fix-config-template-path

Conversation

@MackDing
Copy link
Copy Markdown

@MackDing MackDing commented May 20, 2026

Summary\n- fix the config template copy command in README_zh.md\n- align the Chinese setup instructions with the English README and the existing Telegram template path\n\n## Why\nThe Chinese README currently tells users to copy , but the English README and the documented Telegram setup use . This small docs fix reduces setup confusion and keeps the two READMEs consistent.\n\n## Verification\n- verified now contains

Summary by Sourcery

文档:

  • 修正 README_zh.md 中的配置模板复制命令,使其指向用于 settings.jsonc 的 Telegram 示例模板。
Original summary in English

Summary by Sourcery

Documentation:

  • Correct the config template copy command in README_zh.md to point to the Telegram example template for settings.jsonc.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 20, 2026

审查者指南(在小型 PR 上折叠显示)

审查者指南

更新了中文 README 中的 Telegram 配置模板路径,使其与英文 README 和现有模板文件保持一致,从而确保安装步骤匹配。

文件级变更

变更 详情 文件
在中文 README 中更正了配置模板的复制命令,使其引用 Telegram 示例模板。
  • 更新了 bash 复制命令,将 examples/tg.template.jsonc 用作 settings.jsonc 的源模板
  • 保持周围关于多模态模型配置的说明和链接不变,以便与其他文档内容保持一致
README_zh.md

技巧与命令

与 Sourcery 交互

  • 触发新审查: 在 pull request 上评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 从审查评论生成 GitHub issue: 通过回复某条审查评论,请求 Sourcery 从该评论创建一个 issue。你也可以在某条审查评论下回复 @sourcery-ai issue 来从该评论创建 issue。
  • 生成 pull request 标题: 在 pull request 标题的任意位置写入 @sourcery-ai,即可在任意时间生成标题。你也可以在 pull request 上评论 @sourcery-ai title 来(重新)生成标题。
  • 生成 pull request 摘要: 在 pull request 正文的任意位置写入 @sourcery-ai summary,即可在你想要的位置生成 PR 摘要。你也可以在 pull request 上评论 @sourcery-ai summary 来在任意时间(重新)生成摘要。
  • 生成审查者指南: 在 pull request 上评论 @sourcery-ai guide,即可在任意时间(重新)生成审查者指南。
  • 标记所有 Sourcery 评论为已解决: 在 pull request 上评论 @sourcery-ai resolve,即可将所有 Sourcery 评论标记为已解决。如果你已经处理了所有评论且不想再看到它们,这会很有用。
  • 忽略所有 Sourcery 审查: 在 pull request 上评论 @sourcery-ai dismiss,即可忽略所有现有的 Sourcery 审查。如果你想从一次全新的审查开始,这尤其有用——别忘了再评论 @sourcery-ai review 来触发新的审查!

自定义你的体验

访问你的控制台以:

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

获取帮助

Original review guide in English
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the Chinese README to use the correct Telegram configuration template path so that the setup instructions match the English README and existing template files.

File-Level Changes

Change Details Files
Corrected the config template copy command in the Chinese README to reference the Telegram example template.
  • Updated the bash copy command to use examples/tg.template.jsonc as the source template for settings.jsonc
  • Kept surrounding multi-modal model configuration note and link unchanged to maintain consistency with other docs content
README_zh.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

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - 我已经审查了你的更改,一切看起来都很棒!


Sourcery 对开源项目是免费的——如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈改进之后的评审。
Original comment in English

Hey - I've reviewed your changes and they look great!


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.

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