john-slop/docs
Dandaedre 25560fe5d2
docs: split detailed guides from readme
2026-09-29 12:55:53 +02:00
..
decisions docs: define input safety limits 2026-09-29 12:11:33 +02:00
README.md docs: split detailed guides from readme 2026-09-29 12:55:53 +02:00
architecture.md docs: split detailed guides from readme 2026-09-29 12:55:53 +02:00
background.md docs: split detailed guides from readme 2026-09-29 12:55:53 +02:00
development.md docs: split detailed guides from readme 2026-09-29 12:55:53 +02:00
usage.md docs: split detailed guides from readme 2026-09-29 12:55:53 +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:

  • Usage documents accepted inputs, detector output, exit statuses, and the current formatter/LSP status.
  • Architecture describes module boundaries, shared domain values, input safety, and the reusable library facade.
  • 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.