Skip to content

docs: README onboarding overhaul + TypeScript plugin README#493

Closed
klausagnoletti wants to merge 1 commit intopeteromallet:mainfrom
klausagnoletti:docs/readme-onboarding-overhaul
Closed

docs: README onboarding overhaul + TypeScript plugin README#493
klausagnoletti wants to merge 1 commit intopeteromallet:mainfrom
klausagnoletti:docs/readme-onboarding-overhaul

Conversation

@klausagnoletti
Copy link
Contributor

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:

  • What it is / What it isn't — appears right after the one-liner. The main thing missing: new users (including me) read this as an auto-fix tool. This section makes it clear up front that desloppify finds and queues the work; you or your agent does the fixing.
  • Supported Languages — the --exclude flag doesn't filter findings from orphaned, single_use, and cycles detectors #1 question any new user has ("does this work for my stack?") was completely unanswered. Two-tier table: 9 full plugins with extensions and external tool requirements, then the 23+ generic plugins listed out.
  • Quick start — three commands to go from zero to first scan, with a note on excluding vendor/build dirs and adding .desloppify/ to .gitignore.
  • Key concepts — one-sentence definitions of overall score, strict score, triage, and subjective review. These terms show up everywhere in the tool output but were never explained.

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

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>
@peteromallet
Copy link
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:

  • The TypeScript README has incorrect test paths (desloppify/languages/typescript/tests/ — tests are actually at desloppify/tests/) and includes draft-note language ("The framing to nail:") that would need cleanup
  • Detailed internal layout docs (like the TS README's maintainer notes) tend to drift quickly as the codebase evolves, and inaccurate docs can be worse than no docs
  • We're keeping the README minimal for now — the tool's built-in coaching (scan, plan, next commands) is the primary onboarding path

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!

peteromallet added a commit that referenced this pull request Mar 21, 2026
…ues #494-#490

Stage 1 assessments, Stage 2 challenges/advocacy, and Stage 3 execution
for the current batch of open PRs and issues. Backfilled Stage 2 files
for older items that only had Stage 1 results.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants