john-slop/docs
Dandaedre d2f6f01fcd
Gitea/john-slop/pipeline/head There was a failure building this commit Details
ci: publish current coverage badges
2026-10-03 03:07:43 +02:00
..
decisions chore: prepare 0.1.27-rc.3 2026-09-30 20:27:41 +02:00
experiments chore: prepare 0.1.27-rc.3 2026-09-30 20:27:41 +02:00
README.md feat: add research-backed review signals 2026-09-30 02:23:59 +02:00
advanced.md build: remove SBOM generation 2026-09-30 14:57:45 +02:00
architecture.md chore: prepare 0.1.27-rc.3 2026-09-30 20:27:41 +02:00
background.md docs: publish evidence score terminology 2026-09-29 21:08:03 +02:00
benchmarks.md perf: add scaling benchmark suite 2026-09-29 17:36:49 +02:00
configuration.md chore: prepare 0.1.27-rc.3 2026-09-30 20:27:41 +02:00
dependencies.md build: remove SBOM generation 2026-09-30 14:57:45 +02:00
development.md ci: publish current coverage badges 2026-10-03 03:07:43 +02:00
editors.md chore: prepare 0.1.27-rc.3 2026-09-30 20:27:41 +02:00
evaluation.md feat: add research-backed review signals 2026-09-30 02:23:59 +02:00
heuristics.md feat: add research-backed review signals 2026-09-30 02:23:59 +02:00
limitations.md chore: release milestone 22 2026-09-30 00:42:04 +02:00
output.md chore: release milestone 22 2026-09-30 00:42:04 +02:00
releasing.md chore: prepare 0.1.27-rc.8 2026-09-30 22:41:09 +02:00
review-signals.md feat: add research-backed review signals 2026-09-30 02:23:59 +02:00
unicode-confusables.md fix: width-fold fullwidth ASCII deterministically 2026-09-30 01:50:49 +02:00
usage.md feat: make LSP diagnostics Unicode-first 2026-09-30 02:26:52 +02:00

README.md

John Slop documentation

The root README gets you from installation to a first scan. Move through these guides as your needs grow; you do not need to understand the internals to use the tools.

Start using it

  1. Usage covers accepted inputs, detector options, stable exit statuses, formatter modes, and the LSP command.
  2. Output explains graphical Miette reports, plain human output, concise records, versioned JSON Lines, and partial input errors.
  3. Configuration documents source precedence, named profiles, stable-ID merges, validation, and inspection commands. Start from the commented examples.

Put it into practice

  1. Runnable examples demonstrate in-memory analysis, streaming path input, shared replacement planning, and an expected-failure diagnostic showcase.
  2. Editor setup provides working Helix (hx) and Vim formatter and LSP configurations with validation steps.
  3. Review signals and evidence methodology explains the research boundary, evidence tiers, and deliberately excluded proxies.
  4. Heuristics and evidence scoring explains what each rule contributes and how the bounded score is calculated.
  5. Limitations covers false positives, evasion, domain shift, score semantics, and safe interpretation.

Go deeper

The advanced guide is the single entry point for architecture, the public library API, evaluation, benchmarks, dependencies, design records, research references, development, security, and releases.

Project work is tracked in tasks.md, while contribution policy is defined in CONTRIBUTING.md and AGENTS.md.