docs: 完成中文化治理和 Hub Server 需求归档 - #9
Conversation
There was a problem hiding this comment.
Code Review
This pull request implements a comprehensive documentation language policy, transitioning core project documentation (README, AGENTS, Glossary, Project Management) to Chinese while maintaining English for code, protocols, and commit messages. It introduces new GitHub Issue and PR templates, a documentation roadmap, and "neat-freak" synchronization rules for the knowledge base. Review feedback identifies inconsistencies in the self-check PowerShell commands provided across AGENTS.md and the roadmap document, suggesting a unified and more thorough command to ensure proper documentation coverage and consistency with the PR's objectives.
| ### 自检命令 | ||
|
|
||
| ```powershell | ||
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md -Pattern (('README_Z' + 'H') + '|MVP') |
There was a problem hiding this comment.
自检命令中的搜索模式和路径列表与 PR 摘要中提供的不一致。此处的模式包含了 |MVP 但缺少了 SSOT 等关键术语,且路径中缺少了 .github 目录下的模板文件。建议统一使用 PR 摘要中更完整的命令,以确保检查覆盖面并保持一致性。
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md -Pattern (('README_Z' + 'H') + '|MVP') | |
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md,.\.github\*.md,.\.github\ISSUE_TEMPLATE\*.md -Pattern (('README_Z' + 'H') + '|SSOT|不要求全文翻译|不做机械全文翻译') |
| 每批翻译后至少检查: | ||
|
|
||
| ```powershell | ||
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md -Pattern ('README_Z' + 'H') |
There was a problem hiding this comment.
此处的自检命令与 AGENTS.md 中的不一致,且模式和路径列表均不完整(缺少了 SSOT 等术语以及 .github 路径)。建议统一使用 PR 摘要中推荐的完整命令。
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md -Pattern ('README_Z' + 'H') | |
| Select-String -Path .\README.md,.\README_EN.md,.\AGENTS.md,.\docs\*.md,.\docs\reference\README.md,.\.github\*.md,.\.github\ISSUE_TEMPLATE\*.md -Pattern (('README_Z' + 'H') + '|SSOT|不要求全文翻译|不做机械全文翻译') |
There was a problem hiding this comment.
Pull request overview
该 PR 将仓库文档入口与协作规范调整为“中文为主、英文为辅”,并补齐文档中文化路线图、语言规则与 GitHub 协作模板,以支持 Issue #8 的“分批中文化”目标。
Changes:
- 将中文 README 设为主入口(
README.md),新增英文入口README_EN.md并移除旧README_ZH.md - 新增文档语言规则与中文化路线图,补齐调研索引与项目管理文档的中文规范
- 更新
AGENTS.md、新增 GitHub Issue/PR 模板,并在 hooks 注释中说明 commit 与 issue/PR 的语言边界
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | 切换为中文主入口,并更新导航链接与文档索引 |
| README_ZH.md | 删除旧中文 README(入口迁移到 README.md) |
| README_EN.md | 新增英文 README 作为对外补充入口 |
| docs/reference/README.md | 增加 reference 区域的语言规则与中文化路线图入口 |
| docs/project-management.md | 中文化项目管理规范,并补充 Issue/PR 语言与标题规则 |
| docs/language-policy.md | 新增全仓库文档语言政策与边界约束 |
| docs/glossary.md | 中文化术语表并补充推荐叫法 |
| docs/chinese-documentation-roadmap.md | 新增分批中文化执行路线图与验收清单 |
| AGENTS.md | 补充中文优先规则、neat-freak 同步规则与协作规范入口 |
| .gitignore | 忽略本地 agent worktrees 目录 |
| .github/PULL_REQUEST_TEMPLATE.md | 新增 PR 模板(中文为主、前缀规范、检查命令) |
| .github/ISSUE_TEMPLATE/task.md | 新增聚合任务 issue 模板(中文为主、标题前缀) |
| .githooks/prepare-commit-msg | 注释补充 commit 与 issue/PR 语言边界说明 |
| .githooks/commit-msg | 注释补充 commit 与 issue/PR 语言边界说明 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 当前 `master` 保护: | ||
|
|
||
| - pull request path required | ||
| - 要求 Pull Request 路径 |
| | `revert` | 回滚提交 | | ||
|
|
||
| - Scope 可选,只用小写 `[a-z0-9._-]+`。 | ||
| - Description 使用小写英文,不加句号,最长 72 字符。 |
cc8687c to
34e6c67
Compare
34e6c67 to
2b0a943
Compare
…abindex (UIUX #9+#7) ConversationSidebar: wrap conversation list in <Virtualizer scrollRef bufferSize=800> (mirrors Transcript.tsx pattern) for 500+ conversation performance. Add onContextMenu → reuse ContextMenu.tsx (viewport clamp + ESC + focus trap) with pin/unpin/archive/rename/delete/copy-link actions (only those with existing action support; others TODO not fabricated). Roving tabindex: aria-activedescendant + ArrowUp/Down/Home/End, single tab stop. Fix: scrollToIndex align 'auto' → 'center' (virtua ScrollToIndexAlign doesn't accept 'auto'). virtua passthrough mock already in shared setup.ts. shared 1570/1570 green (sidebar roving covered by AgentHubWorkbench.test 64/64). tsc net 0 new errors. fable UIUX gap scan #9 (sidebar long-list UX) + #7 sidebar portion.
…abindex (UIUX #9+#7) ConversationSidebar: wrap conversation list in <Virtualizer scrollRef bufferSize=800> (mirrors Transcript.tsx pattern) for 500+ conversation performance. Add onContextMenu → reuse ContextMenu.tsx (viewport clamp + ESC + focus trap) with pin/unpin/archive/rename/delete/copy-link actions (only those with existing action support; others TODO not fabricated). Roving tabindex: aria-activedescendant + ArrowUp/Down/Home/End, single tab stop. Fix: scrollToIndex align 'auto' → 'center' (virtua ScrollToIndexAlign doesn't accept 'auto'). virtua passthrough mock already in shared setup.ts. shared 1570/1570 green (sidebar roving covered by AgentHubWorkbench.test 64/64). tsc net 0 new errors. fable UIUX gap scan #9 (sidebar long-list UX) + #7 sidebar portion. Co-authored-by: Codex <codex@vectorcontrol.tech>
摘要
origin/server—hub分支里的 Hub Server 需求草案迁移到docs/reference/03-build/backend/16-hub-server-requirements.md,没有原样合并该分支的 README/.gitkeep 删除改动。services/hub-server/README.md作为服务入口,链接 Hub Server 需求文档。docs/reference/README.md的文档数量与索引,reference 文档数从 68 调整为 69。reference/**第三方仓库未触碰。关联 issue
Closes #8
治理结果
docs/reference/**自有调研/规格文档已中文化覆盖。services/hub-server的 README 和.gitkeep保留。origin/server—hub的有效内容已吸收为规范路径下的文档。验收
git diff --check HEAD~1..HEADreference/**第三方仓库docs/reference/03-build/backend/检查命令