# Documentation

[한국어](README.ko.md)

This directory keeps the supporting material for PolyHarness. The root [README](../README.md) is the quickest path for setup and smoke testing.

## Recommended Reading Order

1. [Project README](../README.md): status, quick start, mock mode, Ollama mode, and safety notes.
2. [Static experiment report](index.html): the HTML artifact intended for GitHub Pages when `/docs` is selected as the Pages source.
3. [Local Ollama pipeline case](local-ollama-pipeline-case.md): the recorded end-to-end local test without an OpenAI API key.
4. [Token benchmark notes](token-benchmark-notes.md): how to interpret prompt-token and total-token measurements.
5. [Benchmarks](benchmarks/README.md): benchmark fixtures, commands, and generated outputs.
6. [Static result page note](static-result-page-note.md): publishing-safe notes for `docs/index.html`.

## Language Convention

English is the default documentation language. Korean versions use the same path with a `.ko.md` suffix.

Examples:

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

Each document should link to its counterpart near the top so readers can switch languages without returning to this index.

## Public Release Check

Before publishing, verify:

- No API keys, `.env` files, local virtual environments, caches, or private paths are committed.
- Debug endpoints are described as local-only and not safe for public exposure.
- Benchmark claims include the model, date, dataset size, and limitations.
- Total-token savings are not presented as guaranteed.
- Product-like language is avoided unless the repository later becomes a maintained product.

## GitHub Pages Source

This repository is prepared for GitHub Pages with `/docs` as the source folder. `index.html` is the public entry point and `.nojekyll` keeps GitHub Pages from applying Jekyll processing to the static artifact.