Skip to content

docs: add standalone debugger documentation#58

Merged
ryanbas21 merged 1 commit into
mainfrom
docs/standalone-debugger
May 15, 2026
Merged

docs: add standalone debugger documentation#58
ryanbas21 merged 1 commit into
mainfrom
docs/standalone-debugger

Conversation

@ryanbas21
Copy link
Copy Markdown
Owner

Summary

  • Add guide page (/docs/standalone-debugger) covering quick start, configuration, sessions, MCP mode, Node.js HTTP interceptor, and troubleshooting
  • Add package reference page (/packages/devtools-standalone) with WebSocket protocol, MCP tools table, Effect services, and architecture diagram
  • Update bridge package page with attachDebugger section and standalone connection docs
  • Update getting-started page with standalone quick start section
  • Update repository structure with standalone in package map and dependency graph
  • Add standalone package card (tagged "New") to homepage grid
  • Add standalone to architecture SVG diagram and package relationship descriptions

Test plan

  • Run pnpm dev in apps/docs/ and verify new pages render at /docs/standalone-debugger and /packages/devtools-standalone
  • Verify updated pages render correctly: /packages/devtools-bridge, /docs/getting-started, /contributing/repository-structure
  • Verify homepage shows the new standalone package card with "New" tag
  • Verify architecture diagram includes the standalone box and arrows
  • Check all internal links resolve (standalone guide ↔ package reference, bridge → standalone)
  • Run pnpm build to confirm elm-pages compiles without errors

🤖 Generated with Claude Code

Copy link
Copy Markdown
Contributor

@pullfrog pullfrog Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

The SVG architecture diagram has an arrow coordinate bug—the devtools-types → devtools-standalone arrow starts at the bottom of the devtools-bridge box instead of the bottom of devtools-types. This will render as a bridge→standalone dependency, which is incorrect.

TL;DR — Adds two new doc pages (standalone debugger guide + package reference), updates the bridge page with attachDebugger API docs, and adds the standalone package to the architecture diagram, homepage grid, and repo structure page. Comprehensive docs rollout for the standalone Electron debugger.

Key changes

  • New standalone debugger guide — quick start, configuration, session tracking, MCP mode, Node.js HTTP interceptor, troubleshooting
  • New standalone package reference — installation, modes, WebSocket protocol, MCP tools table, Effect services list, architecture diagram
  • Update bridge package docs — add attachDebugger section with options table, DebuggerHandle interface, and lifecycle explanation
  • Update getting-started — add standalone quick start section with code example
  • Update architecture diagram — add standalone box, arrow, and package description to the OIDC DevTools group
  • Update homepage — add standalone package card with "New" tag to the grid
  • Update repo structure — add standalone to package table and dependency graph

Summary | 7 files | 1 commit | base: maindocs/standalone-debugger

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run𝕏

Comment thread apps/docs/app/Route/Architecture.elm Outdated
@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog Bot commented May 15, 2026

Addressed the review comment on the architecture diagram. The devtools-types → devtools-standalone arrow was starting at y=260 (bottom of bridge) instead of y=140 (bottom of types). Fixed by changing svgArrow 180 260 180 320svgArrow 120 140 120 320 in Architecture.elm:134, which also avoids overlap with the types→bridge arrow at x=180. Committed as 1b34d22, pushed, replied, and thread resolved.

Task list (3/3 completed)
  • Read Architecture.elm to understand the arrow coordinate bug
  • Fix the svgArrow coordinates for types→standalone
  • Commit, push, reply, resolve, and report progress

Pullfrog  | View workflow run | via Pullfrog𝕏

- Add guide page for the standalone debugger (getting started,
  configuration, sessions, MCP mode, troubleshooting)
- Add package reference page covering WebSocket protocol, MCP tools,
  Effect services, and architecture
- Update bridge package page with attachDebugger section
- Update getting-started with standalone debugger quick start
- Update repository-structure with standalone in package map and
  dependency graph
- Add standalone package card to homepage
- Add standalone to architecture diagram and package relationships

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ryanbas21 ryanbas21 force-pushed the docs/standalone-debugger branch from 1b34d22 to fd63d15 Compare May 15, 2026 06:08
Copy link
Copy Markdown
Contributor

@pullfrog pullfrog Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No new issues. The prior review's sole finding (SVG arrow coordinate bug in the devtools-types → devtools-standalone arrow) was addressed by removing the incorrect arrow.

Reviewed the following changes:

  • Expanded SVG viewBox and added the standalone box + core→standalone arrow; removed the buggy types→standalone arrow instead of repositioning it
  • Added standalone package card ("New" tag) to the homepage grid

Pullfrog  | View workflow run𝕏

@ryanbas21 ryanbas21 merged commit 1207651 into main May 15, 2026
1 check passed
@ryanbas21 ryanbas21 deleted the docs/standalone-debugger branch May 15, 2026 06:15
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.

1 participant