john-slop/docs
Dandaedre 501328d05f
feat: add runtime diagnostic catalog workflow
2026-09-30 01:06:42 +02:00
..
decisions fix: make lsp formatting match formatter 2026-09-30 00:01:38 +02:00
experiments docs: adopt supported cargo workspace 2026-09-29 21:45:32 +02:00
README.md docs: introduce progressive documentation path 2026-09-29 23:28:37 +02:00
advanced.md docs: introduce progressive documentation path 2026-09-29 23:28:37 +02:00
architecture.md feat: add runtime diagnostic catalog workflow 2026-09-30 01:06:42 +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 feat: add runtime diagnostic catalog workflow 2026-09-30 01:06:42 +02:00
dependencies.md chore: release milestone 21 2026-09-30 00:15:34 +02:00
development.md chore: release milestone 23 2026-09-30 00:56:01 +02:00
editors.md feat: add runtime diagnostic catalog workflow 2026-09-30 01:06:42 +02:00
evaluation.md chore: release milestone 23 2026-09-30 00:56:01 +02:00
heuristics.md feat: add runtime diagnostic catalog workflow 2026-09-30 01:06:42 +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: synchronize milestone package version 2026-09-29 23:52:36 +02:00
unicode-confusables.md chore: release milestone 22 2026-09-30 00:42:04 +02:00
usage.md feat: add runtime diagnostic catalog workflow 2026-09-30 01:06:42 +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. Heuristics and evidence scoring explains what each rule contributes and how the bounded score is calculated.
  4. 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.