38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
# John Slop documentation
|
|
|
|
The root [README](../README.md) 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](usage.md) covers accepted inputs, detector options, stable exit
|
|
statuses, formatter modes, and the LSP command.
|
|
2. [Output](output.md) explains graphical Miette reports, plain human output,
|
|
concise records, versioned JSON Lines, and partial input errors.
|
|
3. [Configuration](configuration.md) documents source precedence, named
|
|
profiles, stable-ID merges, validation, and inspection commands. Start from
|
|
the [commented examples](../examples/config/).
|
|
|
|
## Put it into practice
|
|
|
|
4. [Runnable examples](../examples/README.md) demonstrate in-memory analysis,
|
|
streaming path input, shared replacement planning, and an expected-failure
|
|
diagnostic showcase.
|
|
5. [Editor setup](editors.md) provides working Helix (`hx`) and Vim formatter
|
|
and LSP configurations with validation steps.
|
|
6. [Heuristics and evidence scoring](heuristics.md) explains what each rule
|
|
contributes and how the bounded score is calculated.
|
|
7. [Limitations](limitations.md) covers false positives, evasion, domain shift,
|
|
score semantics, and safe interpretation.
|
|
|
|
## Go deeper
|
|
|
|
The [advanced guide](advanced.md) 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](../tasks.md), while contribution policy is
|
|
defined in [CONTRIBUTING.md](../CONTRIBUTING.md) and
|
|
[AGENTS.md](../AGENTS.md).
|