Skip to content

Commit 28f8ffe

Browse files
committed
Mirror Korean docs under notes
1 parent 3665db3 commit 28f8ffe

8 files changed

Lines changed: 36 additions & 20 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository is B4Bot, the agent-based project management bot for Blueprint4Agent.
44

5-
Korean version: `AGENTS.ko.md`
5+
Korean translation: `notes/ko/AGENTS.md`
66

77
## Repository Scope
88

@@ -20,13 +20,15 @@ Default policy:
2020
## Required Read Order
2121

2222
1. `AGENTS.md` or `AGENTS.ko.md`
23-
2. `README.md` or `README.ko.md`
23+
- Korean translation: `notes/ko/AGENTS.md`
24+
2. `README.md`
25+
- Korean translation: `notes/ko/README.md`
2426
3. `docs/configuration.md`
25-
- Korean translation: `notes/ko/configuration.md`
27+
- Korean translation: `notes/ko/docs/configuration.md`
2628
4. `docs/issue-generation-policy.md`
27-
- Korean translation: `notes/ko/issue-generation-policy.md`
29+
- Korean translation: `notes/ko/docs/issue-generation-policy.md`
2830
5. `docs/priority-policy.md`
29-
- Korean translation: `notes/ko/priority-policy.md`
31+
- Korean translation: `notes/ko/docs/priority-policy.md`
3032
6. Provider-specific docs when editing provider adapters
3133

3234
## Architecture
@@ -38,7 +40,7 @@ Default policy:
3840
- `src/providers/`: AI provider adapters
3941
- `src/review/`: issue generation planning and normalization
4042
- `docs/`: English user-facing operating policies
41-
- `notes/ko/`: Korean translations for user-facing operating policies
43+
- `notes/ko/`: Korean translations that mirror the root repository structure
4244
- `templates/`: target repository setup examples
4345

4446
## Development Rules
@@ -47,9 +49,9 @@ Default policy:
4749
- Keep provider implementations behind the `AiProvider` interface.
4850
- Do not store provider API keys in this repository.
4951
- Use target repository secrets such as `B4BOT_PROVIDER_API_KEY`.
50-
- Keep `AGENTS.md` and `AGENTS.ko.md` synchronized.
51-
- Keep `README.md` and `README.ko.md` synchronized.
52-
- Keep Korean translations under `notes/ko/` synchronized with English docs under `docs/`.
52+
- Keep `AGENTS.md` and `notes/ko/AGENTS.md` synchronized.
53+
- Keep `README.md` and `notes/ko/README.md` synchronized.
54+
- Keep Korean translations under `notes/ko/docs/` synchronized with English docs under `docs/`.
5355

5456
## Verification
5557

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,13 @@ The MVP includes:
7575
## Documentation
7676

7777
- English operating docs are maintained under `docs/`.
78-
- Korean translations are maintained under `notes/ko/`.
78+
- Korean translations mirror the repository structure under `notes/ko/`.
79+
80+
Examples:
81+
82+
- `AGENTS.md` -> `notes/ko/AGENTS.md`
83+
- `README.md` -> `notes/ko/README.md`
84+
- `docs/configuration.md` -> `notes/ko/docs/configuration.md`
7985

8086
## Development
8187

AGENTS.ko.md renamed to notes/ko/AGENTS.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,16 @@ B4Bot은 대상 저장소를 검토하고 scope별 프로젝트 관리 이슈를
1919

2020
## 필수 문서 읽기 순서
2121

22-
1. `AGENTS.md` 또는 `AGENTS.ko.md`
23-
2. `README.md` 또는 `README.ko.md`
22+
1. `AGENTS.md`
23+
- 한국어 번역: `notes/ko/AGENTS.md`
24+
2. `README.md`
25+
- 한국어 번역: `notes/ko/README.md`
2426
3. `docs/configuration.md`
25-
- 한국어 번역: `notes/ko/configuration.md`
27+
- 한국어 번역: `notes/ko/docs/configuration.md`
2628
4. `docs/issue-generation-policy.md`
27-
- 한국어 번역: `notes/ko/issue-generation-policy.md`
29+
- 한국어 번역: `notes/ko/docs/issue-generation-policy.md`
2830
5. `docs/priority-policy.md`
29-
- 한국어 번역: `notes/ko/priority-policy.md`
31+
- 한국어 번역: `notes/ko/docs/priority-policy.md`
3032
6. provider adapter를 수정할 경우 provider 관련 문서
3133

3234
## 구조
@@ -38,7 +40,7 @@ B4Bot은 대상 저장소를 검토하고 scope별 프로젝트 관리 이슈를
3840
- `src/providers/`: AI provider adapter
3941
- `src/review/`: issue 생성 계획과 정규화
4042
- `docs/`: 영어 사용자 대상 운영 정책
41-
- `notes/ko/`: 사용자 대상 운영 정책의 한국어 번역
43+
- `notes/ko/`: 루트 저장소 구조를 따라가는 한국어 번역
4244
- `templates/`: 대상 저장소 설정 예시
4345

4446
## 개발 규칙
@@ -47,9 +49,9 @@ B4Bot은 대상 저장소를 검토하고 scope별 프로젝트 관리 이슈를
4749
- provider 구현은 `AiProvider` 인터페이스 뒤에 둔다.
4850
- provider API key를 이 저장소에 저장하지 않는다.
4951
- `B4BOT_PROVIDER_API_KEY` 같은 대상 저장소 secret을 사용한다.
50-
- `AGENTS.md``AGENTS.ko.md`를 동기화한다.
51-
- `README.md``README.ko.md`를 동기화한다.
52-
- `docs/`의 영어 문서와 `notes/ko/`의 한국어 번역을 동기화한다.
52+
- `AGENTS.md``notes/ko/AGENTS.md`를 동기화한다.
53+
- `README.md``notes/ko/README.md`를 동기화한다.
54+
- `docs/`의 영어 문서와 `notes/ko/docs/`의 한국어 번역을 동기화한다.
5355

5456
## 검증
5557

README.ko.md renamed to notes/ko/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,13 @@ MVP에는 다음 provider가 포함된다.
7575
## 문서
7676

7777
- 영어 운영 문서는 `docs/`에서 관리한다.
78-
- 한국어 번역은 `notes/ko/`에서 관리한다.
78+
- 한국어 번역은 `notes/ko/` 아래에서 저장소 구조를 따라 관리한다.
79+
80+
예시:
81+
82+
- `AGENTS.md` -> `notes/ko/AGENTS.md`
83+
- `README.md` -> `notes/ko/README.md`
84+
- `docs/configuration.md` -> `notes/ko/docs/configuration.md`
7985

8086
## 개발
8187

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)