Repository navigation
docs: split README into a short pitch and docs/ pages - #102
Merged
Merged
Conversation
- README shows findings.png, formats.png and suppress.gif again - docs/usage.md links rules.md for groups instead of a stale copy missing provenance - SLOP045 added to the path-gated list - exit 2 also covers a rule that panicked on a file - why.md names prose and image metadata, and the opt-in comment-length cap - "checks" -> "rules" where it meant Rule; no Markdown links inside bash comments - docs pages link back to the docs index - CHANGELOG Changed entry for the split, SARIF helpUri and --rules-doc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README grew to 721 lines, with every rule, the corpus tables and the full config reference inline. This PR turns it into a 117-line pitch (what stopslop is, install, one real run, why, groups, minimal config, CI, non-goals) and moves the long-form content, verbatim, into
docs/:docs/README.mddocs/why.mddocs/usage.mddocs/rules.mddocs/prose.mddocs/configuration.md--check-importsdocs/suppression.mddocs/benchmarks.mdThese files map one to one onto pages of the docs site in #101.
Other changes
--helpfooter points atdocs/README.md.helpUripoints atdocs/rules.md. The oldREADME.md#slopNNNfragment never resolved, because the table has no per-code anchors; docs: rule reference site with one page per rule #101 adds real per-rule pages.bench/score_corpus.py(--readmebecomes--rules-doc) andbench/corpus/results.pyread the rule table fromdocs/rules.md. It parses 51 rows, matching--list-rules.docs/rules.md.Verification
docs/*.mddrops nothing. The 11 changed lines are reflowed text or links that now cross files.README.mdanddocs/*.mdresolves.just checkpasses.stopslop README.md docs/reports zero findings.Merge-order note: The
feat/design-style-layerbranch (#86, #87) adds rule rows to the README table. Whichever of the two lands second moves those rows intodocs/rules.md.