docs: update documentation to match current codebase#50
Conversation
- Rewrite devtools-extension guide with network-first detection, all 10 inspector tabs, diagnosis engine rules, import/export, snapshots, playback, and Learn view layouts - Fix vscode-extension guide: remove nonexistent CodeLens, correct command names, add debug config and troubleshooting - Fix devtools-bridge API docs: add per-bridge signatures with distinct client interfaces (Subscribable, JourneySubscribable, OidcSubscribable) - Fix root README: attachDevToolsBridge → attachDaVinciBridge - Add dead-export-finder and changeset-sync-manifest to package tables, architecture diagram, sidebar, and homepage grid - Add dead-export-finder docs page and package READMEs - Rewrite apps/docs README from stub to full site documentation - Update getting-started to lead with network-first detection - Update repository-structure with missing packages Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Important
Well-researched and accurate doc update overall. Two items to address before merging: missing WorkspaceResult in the new dead-export-finder README, and the changeset-sync-manifest package now appears in the architecture diagram but has no docs site page or sidebar entry.
TL;DR — Rewrites the browser extension guide, VS Code extension guide, and getting-started to match the current codebase. Adds missing packages to architecture, sidebar, index, and tables. Fixes attachDevToolsBridge → attachDaVinciBridge. Creates new doc pages and READMEs.
Key changes
- Rewrites
devtools-extension.md— network-first detection, 10 inspector tabs, 24+ diagnosis engine rules, import/export with redaction, snapshots, time-travel playback, Learn view layout detection - Rewrites
vscode-extension.md— removes nonexistent CodeLens, corrects command names, adds debug config provider, status bar, SDK injection, troubleshooting - Fixes
devtools-bridge.mdAPI docs — per-bridge function signatures with distinct client interfaces, correctconfigtype for OIDC bridge - Adds missing packages —
dead-export-finderandchangeset-sync-manifestadded to tables, architecture diagram, sidebar, homepage grid, and repository structure - Fixes root README —
attachDevToolsBridge→attachDaVinciBridgewith newhandle.detach()pattern - Creates new pages — dead-export-finder docs page, package READMEs for dead-export-finder and changeset-sync-manifest
- Restructures getting-started — leads with network-first detection (no SDK required), adds dead export detection section
Summary | 14 files | 1 commit | base: main ← docs/update-to-current
Missing WorkspaceResult in dead-export-finder README
The packages/dead-export-finder/README.md Types section lists exported types but omits WorkspaceResult, which is exported from src/index.ts:5 as the return type of WorkspaceDetector.detect(). Add it to the import list (see inline comment).
Missing docs page for changeset-sync-manifest
The architecture diagram and repository structure now list @wolfcola/changeset-sync-manifest alongside dead-export-finder, but only dead-export-finder has a docs site content page and sidebar entry. Either add a content page and sidebar link for changeset-sync-manifest, or note in the architecture description that it's an internal CI tool not documented on the site.
Stale attachDevToolsBridge in shipped package READMEs
The PR correctly fixes the bridge function name in the docs site, but the shipped package READMEs (packages/devtools-bridge/README.md, packages/devtools-types/README.md, packages/devtools-extension/README.md) still reference the old attachDevToolsBridge name. Consider updating these in a follow-up to keep npm-published docs consistent with the docs site.
Minor description discrepancies
The dead-export-finder CLI option descriptions differ slightly between the two READMEs:
--verbose:Print timing information and parse warnings(docs page) vsPrint timing, file counts, and parse warnings(package README)--packages: docs page lacks the<name>placeholder shown in the package README
Sync the two sources for consistency.
|
Addressed all review feedback from review #4285934727:
The Task list (5/5 completed)
|
|
@pullfrog approve or request further changes |
There was a problem hiding this comment.
No new issues found.
TL;DR — Comprehensive docs update aligning the documentation site, READMEs, and package guides with the current codebase state.
Key changes
- Add missing packages to ecosystem docs —
dead-export-finderandchangeset-sync-manifestadded to README table, architecture diagram, sidebar, homepage grid, and repository structure - Rewrite devtools-extension guide — Network-first detection, all 10 inspector tabs, 24+ diagnosis engine rules, import/export with redaction, snapshots, time-travel playback
- Fix devtools-bridge API docs — Per-bridge function signatures with typed client interfaces, correct
configtype for OIDC bridge - Fix vscode-extension guide — Removed nonexistent CodeLens, corrected command names, added debug config provider, status bar, SDK injection
- Fix root README —
attachDevToolsBridge→attachDaVinciBridge - Add new pages — Dead-export-finder docs page and package README
- Rewrite apps/docs README — From one-line stub to full site documentation
- Restructure getting-started — Leads with network-first detection (no SDK required)
- Update repo structure docs — Code style, repository structure reflecting all packages
Summary | 14 files | 2 commits | base: main ← docs/update-to-current
Architecture diagram updated
Before: 2 groups (OIDC DevTools, Tree-Shake Tools) with 4 packages
After: 3 groups (OIDC DevTools, Tree-Shake Tools, Utilities) with 8 packages
Added devtools-core, devtools-ui, devtools-extension, vscode-extension, dead-export-finder, and changeset-sync-manifest to the SVG diagram with dependency arrows.
DevTools bridge API docs corrected
Before: Generic
attachXxxBridgesignature with shared prose block
After: Three distinct function signatures withSubscribable,JourneySubscribable, andOidcSubscribableinterfaces
Added concrete TypeScript interface blocks for each client type, corrected the OIDC bridge config parameter type to { clientId?: string } & object, and moved shared bridge behavior (SSR no-op, extension marker check) to the top-level description.
VS Code extension guide fixed
Before: Listed nonexistent CodeLens feature and incorrect command names
After: Correct commands table, debug config provider, status bar, CDP-based network capture, and troubleshooting section
Removed the CodeLens integration (which never existed), replaced old command names (Connect/Disconnect) with the actual names (Start Capture/Stop Capture), added the oidc-devtools debug configuration provider, and added a structured troubleshooting section.
Getting-started restructured
Before: Tree-shake verification first, then OIDC DevTools SDK
After: OIDC DevTools browser extension (no SDK required) first, then bridge SDK, VS Code extension, tree-shake verification, and dead-export-finder
Reordered to lead with the lowest-friction path (install the browser extension, zero code changes) and added the dead-export-finder section.

Summary
Subscribable,JourneySubscribable,OidcSubscribable), correctconfigtype for OIDC bridgeattachDevToolsBridge→attachDaVinciBridge(function never existed)Test plan
pnpm --filter @wolfcola/docs-site buildpasses🤖 Generated with Claude Code