Skip to content

Commit 25e88e8

Browse files
LessUpCopilot
andcommitted
chore(phase1): surface audit and cleanup
- Remove _bmad/ and _bmad-output/ gitignore entries (tasks 1.1, 1.2): directories were never tracked by git; entries are no longer needed - changelog/ was already absent from git (empty dir, not tracked) (task 1.3) - Create docs/TRANSLATION_SCOPE.md declaring bilingual scope policy (task 1.4) - Add zh/index.md note directing Chinese readers to English exercises (task 1.4) - VitePress build confirmed: dist/index.html present, no errors (task 1.5) - Node.js v22.22.0 matches pages.yml node-version: 22; VitePress ^1.6.3 is stable (task 1.6) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 71a7437 commit 25e88e8

3 files changed

Lines changed: 40 additions & 4 deletions

File tree

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,5 @@ build_errors.txt
210210
.vscode/settings.json.user
211211
.vscode/launch.json.user
212212

213-
# BMad Method V6
214-
_bmad/
215-
_bmad-output/
216-
217213
# Local git worktrees
218214
.worktrees/

docs/TRANSLATION_SCOPE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Translation Scope Policy
2+
3+
This document defines which documentation surfaces are maintained bilingually
4+
(English + Simplified Chinese) and which are English-only by design.
5+
6+
## Bilingual surfaces
7+
8+
The following directories are fully bilingual. Every page in `docs/en/` has a
9+
corresponding page in `docs/zh/`:
10+
11+
- `getting-started/`
12+
- `guides/`
13+
- `reference/` (top-level pages: `faq.md`, `troubleshooting.md`, `api-reference.md`)
14+
- `contributing/`
15+
16+
## English-only surfaces
17+
18+
The following are maintained in English only. Chinese readers are directed to the
19+
English version:
20+
21+
- `exercises/` — lab exercises and solutions are tightly coupled to code
22+
examples; translating them would increase maintenance cost without proportional
23+
reader benefit.
24+
- `reference/api/` — auto-generated or low-level API detail pages.
25+
26+
## Reader guidance
27+
28+
A note is present in `docs/zh/index.md` directing Chinese readers to the English
29+
exercises section when they reach that part of the learning path.
30+
31+
## Maintenance rule
32+
33+
When adding a new page to a bilingual surface, add it to both `docs/en/` and
34+
`docs/zh/` in the same commit. When adding a page to an English-only surface,
35+
no Chinese counterpart is required.

docs/zh/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@
1717
- **参考文档** —— FAQ、故障排查、API 入口
1818
- **贡献流程** —— AI 辅助与 OpenSpec 驱动的开发模式
1919

20+
## 练习与实验室
21+
22+
练习模块(`exercises/`)和 API 参考子页面仅提供英文版本,请直接访问
23+
[英文练习页面](/en/exercises/README)
24+
2025
## 贡献者提示
2126

2227
如果你要修改仓库本身,请同时参考:

0 commit comments

Comments
 (0)