2.8 KiB
2.8 KiB
| x-i18n | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
문서 가이드
이 디렉터리는 문서 작성, Mintlify 링크 규칙, 문서 i18n 정책을 담당합니다.
Mintlify 규칙
- 문서는 Mintlify (
https://docs.openclaw.ai)에 호스팅됩니다. docs/**/*.md의 내부 문서 링크는.md또는.mdx접미사 없이 루트 상대 경로를 유지해야 합니다(예:[Config](/gateway/configuration)).- 섹션 상호 참조는 루트 상대 경로의 앵커를 사용해야 합니다(예:
[Hooks](/gateway/configuration-reference#hooks)). - 문서 제목에는 em 대시와 아포스트로피를 사용하지 않아야 합니다. Mintlify 앵커 생성은 이들에 취약하기 때문입니다.
- README 및 기타 GitHub 렌더링 문서는 GitHub 외부에서도 링크가 작동하도록 절대 문서 URL을 유지해야 합니다.
- 문서 내용은 일반적으로 유지해야 합니다. 개인 디바이스 이름, 호스트명 또는 로컬 경로는 사용하지 말고
user@gateway-host같은 플레이스홀더를 사용하세요.
문서 콘텐츠 규칙
- 문서, UI 문구, 선택기 목록에서는 해당 섹션이 런타임 순서 또는 자동 감지 순서를 명시적으로 설명하는 경우가 아니라면 서비스/프로바이더를 알파벳순으로 정렬하세요.
- 번들된 plugin 명명은 루트
AGENTS.md의 저장소 전체 plugin 용어 규칙과 일관되게 유지하세요.
문서 i18n
- 외국어 문서는 이 저장소에서 유지 관리되지 않습니다. 생성된 게시 출력은 별도의
openclaw/docs저장소에 있으며(로컬에서는 종종../openclaw-docs로 클론됨) 그곳에 있습니다. - 여기서
docs/<locale>/**아래의 현지화된 문서를 추가하거나 수정하지 마세요. - 이 저장소의 영어 문서와 용어집 파일을 source of truth로 취급하세요.
- 파이프라인: 여기서 영어 문서를 업데이트하고, 필요에 따라
docs/.i18n/glossary.<locale>.json을 업데이트한 다음, 게시 저장소 동기화와openclaw/docs에서scripts/docs-i18n실행이 이루어지도록 하세요. scripts/docs-i18n을 다시 실행하기 전에, 새 기술 용어, 페이지 제목 또는 영어로 유지되거나 고정 번역을 사용해야 하는 짧은 탐색 레이블에 대한 용어집 항목을 추가하세요.pnpm docs:check-i18n-glossary는 변경된 영어 문서 제목과 짧은 내부 문서 레이블을 검사하는 가드입니다.- 번역 메모리는 게시 저장소의 생성된
docs/.i18n/*.tm.jsonl파일에 저장됩니다. docs/.i18n/README.md를 참조하세요.