운영 안내

Platform Docs는 여러 서비스 저장소의 docs/**/*.md를 한곳에서 탐색하는 정적 사이트입니다.

원칙

문서 원본은 각 서비스 저장소의 docs/ 입니다. 이 허브에서 문서를 수정하지 않습니다.
허브 저장소에는 사이트 설정·동기화 스크립트·CI만 커밋합니다.
docs/services/와 docs/index.md는 빌드 시 생성되며 git에 저장하지 않습니다.

동기화

bash

pnpm sync          # 각 저장소 docs/ → docs/services/<service>/
pnpm docs:dev      # sync 후 로컬 미리보기
pnpm docs:build    # sync 후 정적 빌드

로컬에서는 repos.json의 localPath가 있으면 그 경로에서 복사합니다.
CI에서는 localPath가 없으므로 GitHub에서 --depth 1로 클론합니다.
비공개 저장소는 DOCS_GITHUB_TOKEN(repo read 권한 PAT)이 필요합니다.
DOCS_STRICT=1이면 한 저장소라도 동기화에 실패할 때 빌드가 실패합니다.

새 저장소 추가

repos.json에 id, name, repo, branch, localPath를 추가합니다.
pnpm sync로 동기화되는지 확인합니다.
커밋 후 CI가 새 서비스를 카탈로그와 사이드바에 자동 반영합니다.

링크

서비스별 폴더 구조를 그대로 복사하므로 저장소 내부 상대 링크는 대부분 그대로 동작합니다. 저장소 간 링크가 깨지는 경우에는 해당 문서에서 허브 기준 경로(/services/<id>/...)로 바꿔 주세요.