Skip to content

docs: refresh README — sharper positioning, drop stale content#87

Merged
debugmcpdev merged 1 commit into
mainfrom
docs/readme-refresh
May 31, 2026
Merged

docs: refresh README — sharper positioning, drop stale content#87
debugmcpdev merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@debugmcpdev
Copy link
Copy Markdown
Collaborator

Summary

Refreshes the README to reflect the current state of the project and sharpen its positioning. Docs-only — no code changes.

Positioning

  • Headline & overview reframed around the real differentiator: a headless, out-of-IDE debugger that a CLI agent (e.g. Claude Code) can drive on its own — including remote/container attach over host/port. Now that IDEs expose their debuggers via MCP, "not tied to an editor" is the strongest pitch.
  • New Out-of-IDE & remote attach feature bullet. Verified against the attach_to_process tool schema (host, port, sourcePaths, processId, timeout are all real params), so the claim reflects what ships today. (Turning this into a documented container/k8s workflow is tracked in [FEATURE] Dose it support remote debugging? #15.)

Removed stale / phantom content

  • All four screenshot placeholders and the demo-GIF block (those assets never existed).
  • The hardcoded "1266+ tests" count (long stale; was actually ~2200) → replaced with a self-maintaining "comprehensive test suite" line linking to live CI status, so it can't rot again.
  • The ~15-line Windows Rust setup walkthrough inlined in the feature list → collapsed to a one-line pointer to the existing docs/rust-debugging-windows.md (it was dwarfing every other language).
  • Old 0.16 / 0.17 / 0.19 version banners → a single v0.21.0 + Node 22 note.

Updated

  • Project Status → v0.21.0, all six languages listed evenly.
  • Quick Start gains a Requirements note (Node.js 22+ and per-language toolchains).

Net diff: +14 / −83 lines.

🤖 Generated with Claude Code

- Reframe the headline/overview around the real differentiator: a headless,
  out-of-IDE debugger that a CLI agent (e.g. Claude Code) can drive, including
  remote/container attach over host/port — now that IDEs expose debuggers via
  MCP, "not tied to an editor" is the strongest pitch.
- Add an "Out-of-IDE & remote attach" feature bullet (verified against the
  attach_to_process schema: host/port/sourcePaths supported).
- Remove the four screenshot placeholders and the demo-GIF block (never existed).
- Replace the hardcoded "1266+ tests" (long stale) with a self-maintaining
  "comprehensive test suite" line linking to live CI status.
- Collapse the ~15-line Windows Rust setup walkthrough to a one-line pointer to
  the existing docs/rust-debugging-windows.md.
- Drop the old 0.16/0.17/0.19 version banners; note v0.21.0 + Node 22 once.
- Update Project Status to v0.21.0 with all six languages listed evenly.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@debugmcpdev debugmcpdev merged commit 8bc17fb into main May 31, 2026
9 checks passed
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