Skip to content

docs: update documentation to match current codebase#50

Merged
ryanbas21 merged 2 commits into
mainfrom
docs/update-to-current
May 13, 2026
Merged

docs: update documentation to match current codebase#50
ryanbas21 merged 2 commits into
mainfrom
docs/update-to-current

Conversation

@ryanbas21
Copy link
Copy Markdown
Owner

Summary

  • Rewrite devtools-extension guide — added network-first detection, all 10 inspector tabs, 24+ diagnosis engine rules, import/export with redaction, snapshots, time-travel playback, Learn view layout detection
  • Fix vscode-extension guide — removed nonexistent CodeLens feature, corrected command names, added debug config provider, status bar, SDK injection, troubleshooting
  • Fix devtools-bridge API docs — added per-bridge function signatures with distinct client interfaces (Subscribable, JourneySubscribable, OidcSubscribable), correct config type for OIDC bridge
  • Fix root READMEattachDevToolsBridgeattachDaVinciBridge (function never existed)
  • Add missing packages — dead-export-finder and changeset-sync-manifest added to package tables, architecture diagram, sidebar, homepage grid, and repository structure
  • New pages — dead-export-finder docs page, package READMEs for dead-export-finder and changeset-sync-manifest
  • Rewrite apps/docs README — from one-line stub to full site documentation
  • Update getting-started — leads with network-first detection (no SDK required)

Test plan

  • pnpm --filter @wolfcola/docs-site build passes
  • All 18 pages generated successfully (including new dead-export-finder page)
  • Pre-commit hooks (prettier, syncpack-lint) pass
  • Visual review of architecture diagram SVG layout
  • Verify sidebar navigation includes dead-export-finder
  • Spot-check search index includes new content

🤖 Generated with Claude Code

- 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>
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

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 attachDevToolsBridgeattachDaVinciBridge. 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.md API docs — per-bridge function signatures with distinct client interfaces, correct config type for OIDC bridge
  • Adds missing packagesdead-export-finder and changeset-sync-manifest added to tables, architecture diagram, sidebar, homepage grid, and repository structure
  • Fixes root READMEattachDevToolsBridgeattachDaVinciBridge with new handle.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: maindocs/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) vs Print 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.

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

Comment thread packages/dead-export-finder/README.md
@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog Bot commented May 13, 2026

Addressed all review feedback from review #4285934727:

  • Added WorkspaceResult to the type import list in packages/dead-export-finder/README.md (the inline comment)
  • Clarified architecture description for changeset-sync-manifest as internal CI tool not documented on the docs site (satisfies the review's either/or option)
  • Synced CLI option descriptions between the two dead-export-finder READMEs (--packages <name> and --verbose description)
  • Build verified: pnpm --filter @wolfcola/docs-site build passes

The attachDevToolsBridge issue was noted as a follow-up consideration by the reviewer and is out of scope for this change.

Task list (5/5 completed)
  • Checkout PR docs: update documentation to match current codebase #50 branch
  • Add WorkspaceResult to dead-export-finder README type import list
  • Address changeset-sync-manifest missing docs page
  • Sync CLI option descriptions between READMEs
  • Test, commit, push, reply to comments, and resolve threads

Pullfrog  | View workflow run | via Pullfrog𝕏

@ryanbas21
Copy link
Copy Markdown
Owner Author

@pullfrog approve or request further changes

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 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 docsdead-export-finder and changeset-sync-manifest added 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 config type for OIDC bridge
  • Fix vscode-extension guide — Removed nonexistent CodeLens, corrected command names, added debug config provider, status bar, SDK injection
  • Fix root READMEattachDevToolsBridgeattachDaVinciBridge
  • 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: maindocs/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.

Architecture.elm


DevTools bridge API docs corrected

Before: Generic attachXxxBridge signature with shared prose block
After: Three distinct function signatures with Subscribable, JourneySubscribable, and OidcSubscribable interfaces

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.

devtools-bridge.md


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.

vscode-extension.md


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.

getting-started.md

Pullfrog  | View workflow run𝕏

@ryanbas21 ryanbas21 merged commit c38172a into main May 13, 2026
1 check passed
@ryanbas21 ryanbas21 deleted the docs/update-to-current branch May 13, 2026 23:12
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