john-slop/docs
Dandaedre 5442f3ccec
Gitea/john_slop/pipeline/head There was a failure building this commit Details
test: complete hardening and release milestone
2026-09-29 17:50:43 +02:00
..
decisions docs: select LSP framework 2026-09-29 16:57:21 +02:00
README.md build: add reproducible release packaging 2026-09-29 17:44:06 +02:00
architecture.md docs: publish LSP usage guides 2026-09-29 17:14:04 +02:00
background.md docs: record Unicode confusable catalogs 2026-09-29 17:22:39 +02:00
benchmarks.md perf: add scaling benchmark suite 2026-09-29 17:36:49 +02:00
configuration.md docs: publish release-ready usage and config samples 2026-09-29 17:26:47 +02:00
dependencies.md test: enforce heuristic false-positive sign-off 2026-09-29 17:47:13 +02:00
development.md test: complete hardening and release milestone 2026-09-29 17:50:43 +02:00
editors.md docs: publish LSP usage guides 2026-09-29 17:14:04 +02:00
evaluation.md test: enforce heuristic false-positive sign-off 2026-09-29 17:47:13 +02:00
heuristics.md feat: summarize confidence and severities 2026-09-29 15:49:54 +02:00
limitations.md docs: publish LSP usage guides 2026-09-29 17:14:04 +02:00
output.md feat: add graphical Miette diagnostics 2026-09-29 17:20:24 +02:00
releasing.md build: add reproducible release packaging 2026-09-29 17:44:06 +02:00
unicode-confusables.md docs: record Unicode confusable catalogs 2026-09-29 17:22:39 +02:00
usage.md test: add expected-failure diagnostic showcase 2026-09-29 17:21:20 +02:00

README.md

John Slop documentation

The root README is the short project overview. These guides hold the details needed to use, embed, and develop John Slop:

  • Runnable Rust examples demonstrate in-memory analysis, streaming path input, and shared replacement planning.
  • Usage documents accepted inputs, detector output, exit statuses, formatter modes, and the LSP protocol contract.
  • Editor setup provides working Helix (hx) and Vim formatter/LSP configuration and validation steps.
  • Output contracts specifies human and concise presentation plus the versioned JSON Lines schema and partial-error records.
  • Architecture describes module boundaries, shared domain values, input safety, and the reusable library facade.
  • LSP framework and protocol decision records the selected server crate, stable protocol scope, and synchronization assumptions.
  • Configuration documents schema version 1, source precedence, stable-ID merges, validation, and inspection commands.
  • Commented configuration examples provide user-wide and named partial overlays ready to copy.
  • Heuristics and confidence documents rule execution, applicability, evidence damping, normalization, and score interpretation.
  • Evaluation corpus records fixture provenance, per-rule precision/recall, aggregate false positives, and benchmark caveats.
  • Limitations covers false positives, evasion, domain shift, score semantics, evaluation limits, and operational boundaries.
  • Development covers the supported Rust version, feature matrix, snapshots, coverage, badges, and CI quality gates.
  • Performance benchmarks defines scaling workloads and the evidence required before introducing parallelism.
  • Dependency and binary review records feature choices, advisory/license policy, unsafe boundaries, and release-size measurements.
  • Release procedure defines tagged reproducible packaging, checksums, build provenance, and CycloneDX SBOM generation.
  • Background collects external context on observable signs of low-care AI-assisted writing.
  • Ambiguous and invisible Unicode references records Gitea's locale-aware catalog, its upstream, and safe adoption boundaries.
  • Decision records preserve durable product and engineering choices, including confidence semantics and input limits.

Release-hardening contracts remain specified in tasks.md and AGENTS.md until that milestone lands.