# John Slop documentation The root [README](../README.md) is the short project overview. These guides hold the details needed to use, embed, and develop John Slop: - [Runnable Rust examples](../examples/README.md) demonstrate in-memory analysis, streaming path input, and shared replacement planning. - [Usage](usage.md) documents accepted inputs, detector output, exit statuses, formatter modes, and the LSP protocol contract. - [Editor setup](editors.md) provides working Helix (`hx`) and Vim formatter/LSP configuration and validation steps. - [Output contracts](output.md) specifies human and concise presentation plus the versioned JSON Lines schema and partial-error records. - [Architecture](architecture.md) describes module boundaries, shared domain values, input safety, and the reusable library facade. - [LSP framework and protocol decision](decisions/0003-lsp-framework-and-protocol.md) records the selected server crate, stable protocol scope, and synchronization assumptions. - [Configuration](configuration.md) documents schema version 1, source precedence, stable-ID merges, validation, and inspection commands. - [Commented configuration examples](../examples/config/) provide user-wide and named partial overlays ready to copy. - [Heuristics and evidence scoring](heuristics.md) documents rule execution, applicability, evidence damping, normalization, and score interpretation. - [Evaluation corpus](evaluation.md) records fixture provenance, per-rule precision/recall, aggregate false positives, and benchmark caveats. - [Limitations](limitations.md) covers false positives, evasion, domain shift, score semantics, evaluation limits, and operational boundaries. - [Development](development.md) covers the supported Rust version, feature matrix, snapshots, coverage, badges, and CI quality gates. - [Performance benchmarks](benchmarks.md) defines scaling workloads and the evidence required before introducing parallelism. - [Dependency and binary review](dependencies.md) records feature choices, advisory/license policy, unsafe boundaries, and release-size measurements. - [Release procedure](releasing.md) defines tagged reproducible packaging, checksums, build provenance, and CycloneDX SBOM generation. - [Background](background.md) collects external context on observable signs of low-care AI-assisted writing. - [Ambiguous and invisible Unicode references](unicode-confusables.md) records Gitea's locale-aware catalog, its upstream, and safe adoption boundaries. - [Decision records](decisions/) preserve durable product and engineering choices, including evidence-score semantics and input limits. - [Crate-boundary experiment](experiments/crate-boundary.md) records the measured workspace split, original recommendation, and subsequent adoption decision. - [Workspace architecture decision](decisions/0004-supported-cargo-workspace.md) records the supported package boundaries, inheritance policy, and accepted release cost. Release-hardening contracts remain specified in [tasks.md](../tasks.md) and [AGENTS.md](../AGENTS.md) until that milestone lands.