|
|
||
|---|---|---|
| .. | ||
| decisions | ||
| README.md | ||
| architecture.md | ||
| background.md | ||
| configuration.md | ||
| development.md | ||
| heuristics.md | ||
| usage.md | ||
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.
- 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.
- 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.