docs: plan progressive documentation entry points

This commit is contained in:
Dandaedre 2026-09-29 23:26:03 +02:00
parent 8efa35c45a
commit 6aad159fe8
Signed by: Dandaedre
GPG Key ID: 440C6592E8A26D99
1 changed files with 14 additions and 0 deletions

View File

@ -424,6 +424,20 @@ Accepted on 2026-09-29 after the documented local command installed
`john-slop`, `john-slop-fmt`, and `john-slop-lsp` into an isolated root with the
locked all-feature graph. Formatting and all-feature rustdoc also passed.
## Milestone 17 — Progressive documentation entry points
- [ ] Restructure the root README around an immediately runnable quickstart and
a concise product overview, then present the user-facing guides in a natural
learning order. Move the dense engineering, evaluation, security, and design
navigation behind a dedicated advanced guide and align the documentation
index with the same progression.
Acceptance: a new reader can install and run the detector before encountering
configuration details; the README explains the detector, formatter, and LSP
without duplicating their full guides; common next steps are ordered by likely
need; advanced reference material remains discoverable through one clear entry
point; all local Markdown links resolve and documentation checks pass.
## Deferred by design
- Statistical or model-based authorship classification.