Use this index to choose the right document instead of reading everything in order.
| Document | Use it for |
|---|---|
| quickstart.md | First local run: install, configure providers, create a profile, run daily/read |
| configuration.md | Environment variables, storage paths, Obsidian paths, role settings |
| providers.md | LLM and embedding provider setup |
| Document | Use it for |
|---|---|
| feedback-loop.md | How CLI, GUI, Feishu feedback, reading signals, and profile updates connect |
| ../deployments/desktop/README.md | Local browser GUI panels, feedback behavior, and Feishu doc export switch |
| PaperFlow GUI Preview | No-install GitHub Pages GUI preview with mock data |
| feishu-doc-export.md | Export reading reports as Feishu/Lark docs without webhook/ngrok |
| feishu-webhook-setup.md | Feishu/Lark bot, webhook, ngrok, scheduled pushes, group/role binding |
| Document | Use it for |
|---|---|
| architecture.md | System layers, agents, skills, storage, GUI/Feishu deployment boundaries |
| benchmark.md | PaperFlow-Bench dataset format and evaluation contract |
| reproduce.md | Reproducing experiments and public benchmark artifacts |
| Path | Use it for |
|---|---|
| assets/ | README and documentation images |
Local-only design drafts under docs/*-design/*.local.md are not part of the
public documentation surface.