john-slop/docs/README.md

1.9 KiB

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, and the current formatter/LSP status.
  • Editor setup provides Helix (hx) and Vim configuration for the formatter and future LSP adapter, with current status caveats.
  • 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.
  • Configuration documents schema version 1, source precedence, stable-ID merges, validation, and inspection commands.
  • 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.
  • Background collects external context on observable signs of low-care AI-assisted writing.
  • Decision records preserve durable product and engineering choices, including confidence semantics and input limits.

Future LSP and release-hardening contracts remain specified in tasks.md and AGENTS.md until their implementation milestones land.