docs: reorganize documentation on latest baseline#63
Open
Disaster-Terminator wants to merge 5 commits into
Open
docs: reorganize documentation on latest baseline#63Disaster-Terminator wants to merge 5 commits into
Disaster-Terminator wants to merge 5 commits into
Conversation
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Reviewer's Guide重新组织并扩展文档，引入架构概览和文档治理指南，并将它们接入英文、中文及 docs 索引中，而不改变任何运行时行为。 File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your Experience访问你的 dashboard 以：
Getting HelpOriginal review guide in EnglishReviewer's GuideReorganizes and expands the documentation to introduce an architecture overview and documentation governance guide, and wires them into the English, Chinese, and docs indices without changing any runtime behavior. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - 我给出了一些总体反馈：
- 在
docs/architecture/OVERVIEW.md中，可以考虑简要说明这些可配置的限制（例如，最大活动子代理槽位、等待时间窗口）是在哪里配置或暴露出来的，这样运维人员就能知道是哪些配置项在控制文档中描述的行为。 - 由于
docs/DOCUMENTATION_GOVERNANCE.md引入了受众指南，建议在新的OVERVIEW.md文件顶部附近增加一行简短的“Audience（受众）”说明，用来示范这一约定，并明确主要读者是运维人员还是贡献者。
给 AI 代理的提示
Please address the comments from this code review:
## Overall Comments
- In `docs/architecture/OVERVIEW.md`, consider briefly calling out where the configurable limits (e.g., max active child-agent slots, wait windows) are set or surfaced so operators know which config knobs control the described behavior.
- Since `docs/DOCUMENTATION_GOVERNANCE.md` introduces audience guidance, it may be useful to add a short “Audience” line near the top of the new `OVERVIEW.md` file to model that convention and make the primary reader (operators vs contributors) explicit.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的评审。
Original comment in English
Hey - I've left some high level feedback:
- In
docs/architecture/OVERVIEW.md, consider briefly calling out where the configurable limits (e.g., max active child-agent slots, wait windows) are set or surfaced so operators know which config knobs control the described behavior. - Since
docs/DOCUMENTATION_GOVERNANCE.mdintroduces audience guidance, it may be useful to add a short “Audience” line near the top of the newOVERVIEW.mdfile to model that convention and make the primary reader (operators vs contributors) explicit.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `docs/architecture/OVERVIEW.md`, consider briefly calling out where the configurable limits (e.g., max active child-agent slots, wait windows) are set or surfaced so operators know which config knobs control the described behavior.
- Since `docs/DOCUMENTATION_GOVERNANCE.md` introduces audience guidance, it may be useful to add a short “Audience” line near the top of the new `OVERVIEW.md` file to model that convention and make the primary reader (operators vs contributors) explicit.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mainbaseline (f05b156)docs/README.mdinto a clearer documentation map and link the new docs from both Chinese and English READMEsNotes
This supersedes #62, which was based on an older baseline. The new branch is ahead of
mainand no longer behind it.This is intentionally docs-only. It does not change runtime behavior, plugin manifests, package contents, or generated artifacts.
Verification
mainbefore applying changes.--promptfor sensitive prompts.mainshows only Markdown files changed:README.mdREADME.en.mddocs/README.mddocs/architecture/OVERVIEW.mddocs/DOCUMENTATION_GOVERNANCE.mdSummary by Sourcery
重新组织并扩展文档索引和开发者文档，以在不改变运行时行为的前提下，澄清 Retinue 的架构、产品范围以及文档治理方式。
Documentation:
Original summary in English
Summary by Sourcery
Reorganize and expand the documentation index and developer docs to clarify Retinue’s architecture, product surface, and documentation governance without changing runtime behavior.
Documentation: