# 문서

[English](README.md)

이 디렉터리는 PolyHarness의 보조 문서를 모아둡니다. 설치와 스모크 테스트는 루트 [README.ko.md](../README.ko.md)가 가장 빠른 시작점입니다.

## 권장 읽기 순서

1. [프로젝트 README](../README.ko.md): 상태, 빠른 시작, mock 모드, Ollama 모드, 안전 주의.
2. [정적 실험 리포트](index.html): GitHub Pages source를 `/docs`로 선택했을 때 배포될 HTML 산출물.
3. [로컬 Ollama 파이프라인 사례](local-ollama-pipeline-case.ko.md): OpenAI API 키 없이 수행한 로컬 end-to-end 테스트 기록.
4. [토큰 벤치마크 노트](token-benchmark-notes.ko.md): 프롬프트 토큰과 총 토큰 측정값 해석 방법.
5. [벤치마크](benchmarks/README.ko.md): 벤치마크 픽스처, 실행 명령, 생성 결과.
6. [정적 결과 페이지 노트](static-result-page-note.ko.md): `docs/index.html` 공개용 안내.

## 언어 규칙

기본 문서는 영어입니다. 한국어 문서는 같은 경로에 `.ko.md` 접미사를 붙입니다.

예시:

- `README.md` / `README.ko.md`
- `local-ollama-pipeline-case.md` / `local-ollama-pipeline-case.ko.md`
- `benchmarks/README.md` / `benchmarks/README.ko.md`

각 문서 상단에는 대응 문서 링크를 넣어, 독자가 인덱스로 돌아오지 않아도 언어를 전환할 수 있게 합니다.

## 공개 전 점검

공개 전 다음을 확인하세요.

- API 키, `.env` 파일, 로컬 가상환경, 캐시, 개인 경로가 커밋되지 않았는지.
- 디버그 엔드포인트가 로컬 전용이며 공개 노출에 안전하지 않다고 안내되어 있는지.
- 벤치마크 주장에 모델, 날짜, 데이터셋 크기, 한계가 함께 적혀 있는지.
- 총 토큰 절감을 보장처럼 표현하지 않았는지.
- 저장소가 유지보수되는 제품으로 바뀌기 전까지 제품처럼 보이는 문구를 피했는지.

## GitHub Pages Source

이 저장소는 GitHub Pages source를 `/docs`로 두는 구조에 맞춰져 있습니다. `index.html`이 공개 진입점이고, `.nojekyll`은 GitHub Pages가 정적 산출물에 Jekyll 처리를 적용하지 않도록 둔 파일입니다.