docs(readme): README 영문 기본화 + 한국어판 분리 + 커뮤니티 기여자 하네스
글로벌 방문자에게 한국어 README 는 완전한 이탈 요인인 반면 한국 방문자에게 영문 README 는 한 클릭 불편이라, 비대칭 비용에 맞춰 영문을 기본값으로 둔다. 한국어판은 이력을 보존하도록 git mv 로 옮기고 본문은 그대로 둔다. 커뮤니티 기여자 목록은 공개 CHANGELOG 의 제보자 표기에서 도출한다. 손으로 옮겨 적으면 이슈가 쌓일수록 누락·중복이 생기므로 생성기와 판정기를 한 스크립트로 두고, 세션 종료 시 두 README 와 CHANGELOG 의 불일치를 검사한다. README 가 두 벌이 되면서 버전 뱃지 축도 둘이 됐다. 한 축이 빠져도 나머지가 통과시켜 초록이 누락을 감추므로, 각 축이 독립적으로 red 를 내는지를 합성 저장소로 고정한다.
This commit is contained in:
@@ -79,9 +79,10 @@ G7 의 REST API 는 라우트 `->name()` 규약은 있으나 엔드포인트별
|
||||
- 코어: `docs/backend/api/README.md`
|
||||
- 확장: `{modules|plugins}/_bundled/{id}/docs/api/README.md`
|
||||
|
||||
코어 README 는 프로젝트 최상위 `README.md` 의 "API 레퍼런스" 진입점이다. 따라서 확장 목차와 달리 세
|
||||
부분으로 구성된다. 이 문서(작성 규정)와 혼동되지 않도록 최상위 `README.md` 는 둘을 "API 레퍼런스" 와
|
||||
"API 문서 작성 규정" 으로 분리해 링크한다.
|
||||
코어 README 는 프로젝트 최상위 README 의 "API 레퍼런스" 진입점이다. 따라서 확장 목차와 달리 세
|
||||
부분으로 구성된다. 이 문서(작성 규정)와 혼동되지 않도록 최상위 README 는 둘을 "API 레퍼런스" 와
|
||||
"API 문서 작성 규정" 으로 분리해 링크한다. 최상위 README 는 `README.md`(영문)·`README.ko.md`(한국어)
|
||||
두 벌이며 둘 다 이 진입점을 싣는다 — 한쪽에만 링크가 남으면 그 언어 사용자에게 API 문서가 도달하지 않는다.
|
||||
|
||||
| 구성 | 위치 | 소유 |
|
||||
| --- | --- | --- |
|
||||
@@ -103,7 +104,7 @@ G7 의 REST API 는 라우트 `->name()` 규약은 있으나 엔드포인트별
|
||||
처음 진입하는 개발자/AI 의 도달 경로:
|
||||
|
||||
```text
|
||||
README.md "API 레퍼런스" 또는 AGENTS.md "API 레퍼런스 진입점" 표
|
||||
README.md / README.ko.md "API 레퍼런스" 또는 AGENTS.md "API 레퍼런스 진입점" 표
|
||||
→ docs/backend/api/README.md (공통 규약 + 코어 목차 + 확장 목차)
|
||||
→ {도메인}.md 또는 {확장}/docs/api/README.md
|
||||
→ 엔드포인트별 파라미터·응답·예시
|
||||
|
||||
Reference in New Issue
Block a user