Documentation
| 언어: 🇺🇸 English | 🇰🇷 한국어 |
Ghost-ALICE OS 문서는 reader가 보는 layer에서 영어와 한국어 두 갈래로 둔다. 기본 entry는 English이고, 한국어 문서는 docs/ko/ 아래에 영어 문서와 같은 디렉터리 구조로 둔다.
쌍을 이루는 문서는 모두 상단에 language switch를 둔다. 영어 문서에서는 English가 plain text, Korean이 link이고, 한국어 문서에서는 그 반대다.
Start Here
- 설치와 업데이트는 getting-started/installation.md를 본다.
- update가 막혔으면 getting-started/troubleshooting.md를 본다.
- repository map은 reference/repository-structure.md를 본다.
- installer architecture는 reference/installer-architecture.md를 본다.
- 공개 질문은 SUPPORT.md와 GitHub Issues를 사용한다.
- 비공개 vulnerability report는 SECURITY.md를 따른다.
Documentation Layout
| Area | Role | English | Korean |
|---|---|---|---|
| Getting Started | install, update, recovery, uninstall 절차 | ../getting-started/ | getting-started/ |
| Concepts | project model과 documentation language policy | ../concepts/ | concepts/ |
| Reference | repository map, public skills, hooks, command surfaces | ../reference/ | reference/ |
| Policies | runtime, platform, evaluator contracts | ../policies/ | policies/ |
| Release | public release checks와 validation guidance | ../release/ | release/ |
| Plans | public planning boundaries와 roadmap notes | ../plans/ | plans/ |
Document Map
Update Rule
- English default page를 먼저 수정한다.
- reader-facing meaning, path, command, policy가 바뀌면 같은 change에서 Korean counterpart를 수정한다.
- CLI flags, paths, hook names, skill names, enum values, schema fields는 literal로 유지한다.
- 주변 설명만 번역하고 executable token은 보존한다.
- English 문서는 English 문서끼리, Korean 문서는 counterpart가 있을 때 Korean counterpart끼리 링크한다.
- user-facing document가 추가, 이동, pairing될 때 이 map을 갱신한다.