Skip to content

fix(docs): remove dead ADR references#123

Merged
GeWuYou merged 1 commit into
mainfrom
fix/docs-dead-adr-links
Mar 21, 2026
Merged

fix(docs): remove dead ADR references#123
GeWuYou merged 1 commit into
mainfrom
fix/docs-dead-adr-links

Conversation

@GeWuYou

@GeWuYou GeWuYou commented Mar 21, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

文档:

  • 清理核心框架索引和架构文档中对 ADR-001 的引用,将现已在主文档中涵盖的设计决策细节内联或省略。
Original summary in English

Summary by Sourcery

Documentation:

  • Clean up references to ADR-001 in the core framework index and architecture docs, inlining or omitting design decision details now covered by the main documentation.

@sourcery-ai

sourcery-ai Bot commented Mar 21, 2026

Copy link
Copy Markdown

审阅者指南

此 PR 更新了中文版核心文档,移除了失效的 ADR-001 链接和引用,同时保留了对架构设计的所有概念性和 API 说明,并清理了架构子页面中的相关引用。

文件级变更

变更 详情 文件
从核心总览页面中移除引用 ADR-001 的链接和文本,同时保留架构设计的说明内容。
  • 删除了指向 ADR-001 以获取更多细节的结尾句子,并重写了周边文本,使其可以独立成立。
  • 保留了对模块化架构设计的完整描述,包括生命周期、组件注册表、模块以及它们的优点,但删除了对 ADR-001 的显式提及。
  • 确保版本、更新日志和包表等 front‑matter 部分除了与 ADR 相关的措辞外保持不变。
docs/zh-CN/core/index.md
从架构页面页脚中移除与 ADR-001 相关的文档链接。
  • 从“相关文档”章节中删除了指向 ADR-001 的项目链接,以确保只引用有效的内部文档。
docs/zh-CN/core/architecture.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

This PR updates the Chinese core documentation to remove dead ADR-001 links and references while preserving all conceptual and API descriptions of the Architecture design, and cleans up a related reference in the Architecture subpage.

File-Level Changes

Change Details Files
Remove links and text that reference ADR-001 from the core overview page while keeping the Architecture design explanation intact.
  • Deleted trailing sentences that pointed to ADR-001 for more details and rewrote the surrounding text so it stands on its own.
  • Kept the full description of the modular Architecture design, including lifecycle, component registry, modules, and their advantages, but removed explicit ADR-001 mentions.
  • Ensured front‑matter sections like version, changelog, and package tables remain unchanged apart from ADR‑related wording.
docs/zh-CN/core/index.md
Drop the ADR-001 related-document link from the Architecture page footer.
  • Removed the bullet link to ADR-001 from the "相关文档" section so that only valid internal docs are referenced.
docs/zh-CN/core/architecture.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

@deepsource-io

deepsource-io Bot commented Mar 21, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in 4caa3c0...bf94301 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
C# Mar 21, 2026 7:56a.m. Review ↗
Secrets Mar 21, 2026 7:56a.m. Review ↗

@GeWuYou GeWuYou merged commit 51492b1 into main Mar 21, 2026
5 of 7 checks passed
@GeWuYou GeWuYou deleted the fix/docs-dead-adr-links branch March 21, 2026 07:56

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

Hey - 我已经审查了你的更改,看起来非常棒!


Sourcery 对开源项目是免费的——如果你觉得我们的 review 有帮助,请考虑分享 ✨
帮我变得更有用吧!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进以后的 review。
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