No description
  • Go 89.1%
  • HTML 9%
  • Shell 1.9%
Find a file
Andrew Tyler da3ecb4a57 docs: comprehensive system documentation
Seven documents covering the system as it stands: architecture
(repos + dependency rules, deployment topology, data model, ingest
pipeline, config), pane detection (v1-v11 history, profile ladder +
learned rung, decision pipeline, ground truth/flags/escalation,
accuracy measurement, agent mode, tooling), sorting (comic-sorter in
full, the import folder, the lock protocol, the planned librarian),
metadata (GCD/CV matching, manual + bulk resolution, Fandom events,
the association tree), the API surface map (with openapi.yaml as the
shape contract), the clients (web/desktop/Tauri/Android, remote +
Cast, identity/sync), and operations (build/CI/deploy, observability,
SeaweedFS failure modes with the incident playbook, security posture).
docs/README.md indexes it all.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-11 13:31:07 -05:00
.claude split-work: clarification protocol in the brief template 2026-07-11 13:19:07 -05:00
agent Agent mode: the same binary detects panes for a remote main server 2026-07-08 12:42:00 -05:00
api db: extract ApplyManualSeries as the shared series/publisher writer 2026-07-10 23:45:22 -05:00
archive Convert CBRs to CBZ on scan; metadata follows files across moves 2026-07-03 17:38:47 -05:00
cmd/experiments trainpanes: DB-free training from a portable corrections export 2026-07-08 16:03:49 -05:00
comic-client@98225303b6 comic-client: unmatched form (submodule to master) 2026-07-10 23:31:15 -05:00
comicvine Metadata matching: GCD local first-pass, ComicVine nail-down, cover pHash referee 2026-07-06 22:27:51 -05:00
config Config: add library.import_path for the import-folder ingester 2026-07-10 23:38:51 -05:00
db db: extract ApplyManualSeries as the shared series/publisher writer 2026-07-10 23:45:22 -05:00
docs docs: comprehensive system documentation 2026-07-11 13:31:07 -05:00
fandom Event reading orders from Fandom wikis 2026-07-10 21:43:09 -05:00
gcd Metadata matching: GCD local first-pass, ComicVine nail-down, cover pHash referee 2026-07-06 22:27:51 -05:00
packaging Detection metrics: Prometheus /metrics + Grafana dashboard + Arch doc 2026-07-10 18:45:11 -05:00
panetrain Review loop: re-detect alternatives, mark page/book correct, flag auto-fix indicators 2026-07-06 16:37:41 -05:00
phash Metadata matching: GCD local first-pass, ComicVine nail-down, cover pHash referee 2026-07-06 22:27:51 -05:00
processing Pane accuracy per book + never destroy panes on a failed read 2026-07-10 19:24:57 -05:00
scanner scanner: import-folder ingester draining a staging tree into the library 2026-07-10 23:45:38 -05:00
scraper Metadata matching: GCD local first-pass, ComicVine nail-down, cover pHash referee 2026-07-06 22:27:51 -05:00
scripts scripts/checkup.sh: one-shot build+test+score+smoke harness 2026-07-08 00:16:40 -05:00
third_party gocv: switch to the Forgejo mirror's dev-opencv5 branch (submodule) 2026-07-08 12:17:52 -05:00
.gitignore OpenCV 5 port: vendored gocv with 5.x fixes, pkg-config shim, histogram fix 2026-07-08 04:07:58 -05:00
.gitmodules gocv: switch to the Forgejo mirror's dev-opencv5 branch (submodule) 2026-07-08 12:17:52 -05:00
boys.png Pane detection: replace contour pipeline with recursive XY-cut 2026-07-03 19:46:33 -05:00
build.sh build.sh: use gen-pcshim.sh for the opencv4 alias (was never committed) 2026-07-08 15:26:27 -05:00
CLAUDE.md trainpanes: DB-free training from a portable corrections export 2026-07-08 16:03:49 -05:00
comictv-android API v2: panes as {x,y,w,h} arrays, snake_case JSON throughout 2026-07-03 17:29:41 -05:00
comictv.sqlite-shm Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
comictv.sqlite-wal Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
config.toml.example Config: add library.import_path for the import-folder ingester 2026-07-10 23:38:51 -05:00
go.mod go.mod: tidy (miekg/dns bump pulled by module graph) 2026-07-09 15:25:58 -05:00
go.sum go.mod: tidy (miekg/dns bump pulled by module graph) 2026-07-09 15:25:58 -05:00
kreeader.service Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
main.go Ship a trained pane model; packaged fallback when the cache has none 2026-07-08 13:39:40 -05:00
notes.txt Review loop: re-detect alternatives, mark page/book correct, flag auto-fix indicators 2026-07-06 16:37:41 -05:00
overlap.png Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
PKGBUILD Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
QUESTIONS-2.md Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
QUESTIONS-3.md Cast relay, portable corrections, flagged-page auto-fix, example config 2026-07-06 17:13:10 -05:00
QUESTIONS.md Add answered implementation questionnaire 2026-07-03 17:26:08 -05:00
Ronan.png Rebrand the server to Kreeader everywhere 2026-07-05 17:54:52 -05:00
TODO.md TODO: assess ML-driven auto-tuning (CV constants / ComicVine matching) 2026-07-09 15:37:20 -05:00
webui.go Embed the Kreeader web client (comic-client submodule) + rebrand surfaces + detector v6 2026-07-05 17:48:17 -05:00
wrong.png Adaptive pane detection: per-comic profile voting + detector versioning 2026-07-03 20:52:53 -05:00

Kreeader documentation

Start with architecture.md — the ecosystem map: repositories and their dependencies, deployment topology, the data model, the ingest pipeline, and configuration.

Deep dives:

Doc Covers
pane-detection.md the detector (v1→v11), the profile ladder + learned model, confidence gate, spreads/covers, corrections/flags/escalation, accuracy measurement, agent mode, tooling
sorting.md comic-sorter (dedupe/convert/organize/chown, fingerprinting, resumable state, script mode), the import folder, the lock protocol, the planned librarian
metadata.md GCD/ComicVine matching pipeline, manual + bulk resolution, Fandom event reading orders, the association tree
api.md every HTTP surface and its conventions (the shape contract is ../api/openapi.yaml, served at /docs)
clients.md web/desktop/Tauri (phone remote, Cast, OIDC, updates), Android TV, the shared identity/sync model
operations.md build, packaging/CI, deploy, Grafana observability, SeaweedFS failure modes, coordination/work tracking, security posture
agents.md setting up a remote detection agent
grafana.md Prometheus + Grafana setup on Arch, metric reference