Decision records
Architecturally significant decisions — a dependency or backend choice, a pipeline algorithm, a
public API shape, a model source, a build/target strategy — are recorded as
MADR-format Architecture Decision Records under
adrs/ in the repository. This page is the
index of that log.
- One decision per file, named
NNNN-kebab-title.mdand numbered sequentially from0000. - Front matter carries
status(proposed,accepted,rejected,deprecatedorsuperseded), thedatethe decision was made and itsdecision-makers. A superseded ADR names its successor insuperseded-byand the successor names it insupersedes; a partial change is a new ADR that lists what itamends. - An accepted ADR is never edited. Reversing or changing a decision means adding a new ADR that supersedes or amends the old one.
adrlint lintandadrlint format --checkcheck the log against MADR, configured by.adrlint.toml. Add the new row to this page in the same change as the ADR.
| ADR | Title | Status |
|---|---|---|
| 0000 | Record decisions as MADR ADRs | Accepted |
| 0001 | Cargo workspace: rlib core + thin CLI | Accepted |
| 0002 | Scope to gen2 recognizers + CRAFT | Accepted |
| 0003 | Model source: iText ONNX, runtime download | Accepted |
| 0004 | Inference backend seam: ort / tract / candle | Accepted |
| 0005 | MCP as a feature-gated module + subcommand | Accepted |
| 0006 | Generate agent config with ai-rulez | Accepted |
| 0007 | Tooling scaffolding adapted from basemind | Accepted |
| 0008 | In-repo dev tooling: uv Python fallback + Rust tools/ for model export |
Accepted |
| 0009 | Backend evaluation: ort primary, candle deferred off the critical path |
Accepted |
| 0010 | Public OcrEngine seam, internal DTO boundaries, and encapsulation lockdown |
Accepted |
| 0011 | Re-pointable model registry via a registry_owner override |
Accepted |
| 0012 | ONNX Runtime provisioning: ort-bundled + ort-dynamic (xberg pattern) |
Accepted |
| 0013 | imageproc for CRAFT postprocess geometry |
Accepted |
| 0014 | Public detect / recognize-line methods and a model-provisioning surface | Accepted |
| 0015 | Criterion microbenchmarks behind a bench feature seam |
Accepted |
| 0016 | Parity harness: dual golden fixtures, HF-cache model resolution, and the test corpus | Accepted |
| 0017 | Resolve models through the Hugging Face hub’s native on-disk cache | Accepted |
| 0018 | cv2-exact CRAFT dilation (amends ADR 0013) | Accepted |
| 0019 | Parity-safe performance optimization and SIMD | Accepted |
| 0020 | Release strategy: tag-triggered multi-platform build with crates.io dry-run | Accepted |
| 0021 | Head-to-head benchmark methodology and regression gate | Accepted |
| 0022 | Input image format coverage: pure-Rust decoders only | Accepted |
| 0023 | Publish to crates.io for real, via GitHub Actions trusted publishing | Accepted |
| 0024 | Documentation site, social assets, and CI docs deployment | Superseded by 0033 |
| 0025 | First-party ONNX exports on the sceptre-ocr Hugging Face org |
Accepted |
| 0026 | Extend gen2 scope to Telugu and Kannada | Accepted |
| 0027 | Fixed-canvas CRAFT detection on the tract backend | Accepted |
| 0028 | Host-supplied model artifacts and sequential browser-WASM execution | Accepted |
| 0029 | CLI provisioning default and runtime-scoped parity | Accepted |
| 0030 | Published benchmark artifact and drift gate | Accepted |
| 0031 | Hand-written candle networks as the GPU and no-C++-runtime backend |
Accepted |
| 0032 | Per-backend accelerator support (amends ADR 0029) | Accepted |
| 0033 | Docs on docs.sceptre.xberg.io with the shared @xberg-io/docs-theme |
Accepted |
| 0034 | Test corpus: the test_documents submodule via content-addressed fetch, not vendored fixtures |
Accepted |
| 0035 | Backend x accelerator benchmark matrix (amends ADR 0032) | Accepted |
| 0036 | Opt-in CTC beam-search decoding, greedy stays default | Accepted |
| 0037 | Opt-in whole-page orientation pre-pass, disabled by default | Accepted |
| 0038 | A rotation is applied only when two independent scores agree (amends ADR 0037) | Accepted |
| 0039 | OpenCV-faithful min-area-rect fitting (supersedes ADR 0013’s min-area-rect half) | Accepted |
| 0040 | Model artifacts move to the xberg-io Hugging Face org (amends ADR 0025) |
Accepted |
| 0041 | Opt-in megapixel budget for detection, canvas_size default unchanged |
Accepted |
| 0042 | Host-scoped absolute benchmark floors (amends ADR 0021) | Accepted |
| 0043 | Host-scoped, self-referential warm-speed floor (amends ADR 0021) | Accepted |
| 0044 | One CI check workflow, gated by a paths filter | Accepted |
| 0045 | Row-aware reading order across detection buckets | Accepted |
| 0046 | Retain one ONNX Runtime environment per process | Accepted |
| 0047 | Link the macOS compiler runtime for bundled ONNX Runtime | Accepted |
| 0048 | Qualify reviewed changes on main | Accepted |
| 0049 | Measure a published release and candidate on the same hosted machine | Accepted |
| 0050 | mise tasks and the toolchain baseline | Accepted |
| 0051 | GitHub Actions on major-tag pins and macOS runners on macos-26 | Accepted |
| 0052 | Shared agent governance from agent-conventions modules | Accepted |
| 0053 | Agent plugin and public skills distribution | Accepted |
| 0054 | Resolve cached models offline first | Accepted |
| 0055 | Verify cached models on every cache hit | Accepted |
| 0056 | Shared xberg brand assets for the docs site (amends ADR 0033) | Accepted |
| 0057 | Allow compatible ONNX Runtime binding updates (amends ADR 0046) | Accepted |