john-slop/docs
Dandaedre 1bacd8a75d
docs: add Helix and Vim adapter setup
2026-09-29 16:36:12 +02:00
..
decisions docs: define input safety limits 2026-09-29 12:11:33 +02:00
README.md docs: add Helix and Vim adapter setup 2026-09-29 16:36:12 +02:00
architecture.md docs: publish detector output contracts 2026-09-29 16:05:21 +02:00
background.md docs: split detailed guides from readme 2026-09-29 12:55:53 +02:00
configuration.md feat: expose typed finding diagnostics 2026-09-29 15:48:58 +02:00
development.md test: complete detector CLI milestone 2026-09-29 16:06:56 +02:00
editors.md docs: add Helix and Vim adapter setup 2026-09-29 16:36:12 +02:00
evaluation.md test: add reviewed heuristic corpus 2026-09-29 15:31:46 +02:00
heuristics.md feat: summarize confidence and severities 2026-09-29 15:49:54 +02:00
limitations.md docs: publish detector output contracts 2026-09-29 16:05:21 +02:00
output.md docs: publish detector output contracts 2026-09-29 16:05:21 +02:00
usage.md docs: add Helix and Vim adapter setup 2026-09-29 16:36:12 +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, and the current formatter/LSP status.
  • Editor setup provides Helix (hx) and Vim configuration for the formatter and LSP adapter contracts, with current scaffold 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.

The future configuration, heuristic engine, formatter, and LSP contracts remain specified in tasks.md and AGENTS.md until their implementation milestones land.