31 lines
1.7 KiB
Markdown
31 lines
1.7 KiB
Markdown
# nexo 문서 색인
|
|
|
|
`docs/`는 모든 사용자가 처음부터 끝까지 읽어야 하는 필수 문서 모음이 아니다. 루트 `README.md`가 워크스페이스의 기본 안내이고, 이 디렉터리는 특정 상황에서 참고할 공개 문서와 검증 기록을 둔다.
|
|
|
|
## 먼저 읽을 문서
|
|
|
|
- 전체 프로젝트 개요와 기본 개발 흐름: `../README.md`
|
|
- 작업 규칙과 agent 진입 절차: `../AGENTS.md`
|
|
|
|
## 필요할 때 읽는 문서
|
|
|
|
| 문서 | 읽는 경우 |
|
|
|---|---|
|
|
| `ios-notification-test-guide.md` | iOS 알림 smoke를 위해 Apple/Firebase/기기 준비 항목을 정할 때 |
|
|
| `macos-notification-test-guide.md` | macOS 알림 smoke를 위해 runner, signing, push 범위를 정할 때 |
|
|
| `windows-notification-test-guide.md` | Windows 알림 smoke를 위해 runner, packaging, signing 방식을 정할 때 |
|
|
| `linux-notification-test-guide.md` | Linux 알림 smoke를 위해 runner와 desktop notification 환경을 정할 때 |
|
|
| `runtime-image-validation.md` | runtime image tag, digest, compose smoke 증거를 확인하거나 갱신할 때 |
|
|
|
|
## 모듈별 문서
|
|
|
|
특정 모듈 안에서만 필요한 내용은 해당 모듈의 문서를 우선한다.
|
|
|
|
- Core compose runtime: `../services/core/compose/README.md`
|
|
- Core upstream 기준선: `../services/core/UPSTREAM.md`
|
|
- Mattermost mobile upstream 기준선: `../apps/mattermost/UPSTREAM.md`
|
|
- Mattermost push-proxy upstream 기준선: `../services/push-proxy/UPSTREAM.md`
|
|
|
|
## 중복 방지
|
|
|
|
제품 경계, upstream 추적 정책, 개발 명령, 운영 업데이트 흐름은 루트 `README.md`에 둔다. `docs/README.md`는 그 내용을 반복하지 않고 문서 위치와 읽는 상황만 안내한다.
|