docs: README onboarding overhaul + TypeScript plugin README#493
Closed
klausagnoletti wants to merge 1 commit intopeteromallet:mainfrom
Closed
docs: README onboarding overhaul + TypeScript plugin README#493klausagnoletti wants to merge 1 commit intopeteromallet:mainfrom
klausagnoletti wants to merge 1 commit intopeteromallet:mainfrom
Conversation
Add four missing sections to README.md that left new users stranded: - What it is / What it isn't — sets expectations early; clarifies this is not an auto-fixer and not a linter replacement - Supported Languages — two-tier table (9 full plugins, 23+ generic) with extensions and external tool requirements - Quick start — install + scan + next, three commands with descriptions - Key concepts — one-sentence definitions of overall score, strict score, triage, and subjective review Also creates desloppify/languages/typescript/README.md — the only full plugin that had no README. Covers requirements, project detection, analysis phases, exclusions, auto-fixers, and maintainer notes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Owner
|
Thanks for putting this together, @klausagnoletti — the intent to improve onboarding is appreciated. After review, we're going to pass on this one. A few reasons:
No hard feelings — this is a project direction choice, not a quality judgment. If you're interested in contributing, code fixes and bug reports are always welcome! |
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.
I couldn't figure out how to actually use the tool from reading the README. Eventually I had my AI agent explain it to me — and once it did, it all made sense. I figured I probably wasn't the only one bouncing off the front page, so I had it turn that explanation into proper documentation.
What changed
README.md— four sections added:.desloppify/to.gitignore.desloppify/languages/typescript/README.md— created. TypeScript is the only full plugin with no README. Covers requirements, project detection, every analysis phase in a table, exclusions, auto-fixers, and maintainer notes.Why each piece matters
The agent prompt is great once you know what you're dealing with — but right now a new user hits that wall of text before they know what the tool is or whether it supports their language. The new sections front-load exactly that context so the agent prompt lands with meaning instead of confusion.
🤖 Generated with Claude Code