문서 사이트 운영

MkDocs Material은 Markdown 중심인 이 저장소에 별도 frontend framework를 강요하지 않으면서 검색, 다크 모드, 모바일 화면, 코드 강조, Mermaid, 태그와 이전/다음 이동을 제공합니다.

로컬에서 확인하기

python -m pip install -r requirements.txt
python scripts/sync_readme.py
python scripts/validate_docs.py
mkdocs serve

표시된 local address를 browser에서 열면 수정 내용이 자동 반영됩니다.

문서를 추가하는 방법

1. docs/contributing/editorial-guide.md의 편집 기준을 먼저 확인합니다.
2. docs/contributing/topic-note-template.md의 질문 좁히기 기준으로 글에 맞는 목차를 설계합니다.
3. docs/catalog.json의 적절한 트랙에 페이지와 체크 항목을 추가합니다.
4. 각 체크 항목이 가리키는 실제 앵커를 본문에 둡니다.
5. python scripts/sync_readme.py를 실행합니다.
6. 검증과 엄격 모드 빌드를 통과시킵니다.

docs/SUMMARY.md와 README 체크리스트를 직접 고치지 않습니다. 두 파일은 catalog에서 생성됩니다.