Skip to content

Commit 5ca2248

Browse files
ryanbas21claude
andcommitted
fix(docs-site): fix inaccuracies from content audit
- Fix treeshake-check CLI syntax (no positional args, use --cwd) - Fix event type examples in devtools-extension.md (use real schema types) - Fix unpacked extension path (manifest.json is in package root) - Fix vscode extension ID and name (oidc-devtools by ryanbasmajian) - Fix createBridge reference to attachDaVinciBridge in vscode docs - Fix test file location (co-located in src/, not in test/) - Fix eslint-plugin docs (add missing Object.defineProperties) - Fix repository-structure.md (correct vscode path, add devtools-core/ui) - Fix tree-shaking.md (remove barrel file claim, accurate tool description) - Remove scaffold leftover routes (Greet, Hello, Blog) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent f08e61d commit 5ca2248

10 files changed

Lines changed: 52 additions & 342 deletions

File tree

packages/docs-site/app/Route/Blog/Slug_.elm

Lines changed: 0 additions & 86 deletions
This file was deleted.

packages/docs-site/app/Route/Greet.elm

Lines changed: 0 additions & 107 deletions
This file was deleted.

packages/docs-site/app/Route/Hello.elm

Lines changed: 0 additions & 119 deletions
This file was deleted.

packages/docs-site/content/contributing/code-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ assert.strictEqual(result, 42);
114114

115115
### Test File Location
116116

117-
Test files live in `packages/<name>/test/` directories, mirroring the source structure.
117+
Test files are co-located with source files in `packages/<name>/src/` (e.g. `davinci-bridge.test.ts` next to `davinci-bridge.ts`).
118118

119119
## Elm Conventions
120120

packages/docs-site/content/contributing/repository-structure.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ The wolfcola-devtools repository is a pnpm workspace monorepo. All publishable p
1717
| `@wolfcola/eslint-plugin-treeshake` | `packages/eslint-plugin-treeshake` | ESLint plugin that flags patterns breaking tree-shaking |
1818
| `@wolfcola/devtools-bridge` | `packages/devtools-bridge` | SDK adapter for emitting AuthEvent objects to DevTools |
1919
| `@wolfcola/devtools-types` | `packages/devtools-types` | Effect Schema definitions for AuthEvent and FlowState |
20+
| `@wolfcola/devtools-core` | `packages/devtools-core` | Shared annotators, diagnosis engine, event store |
21+
| `@wolfcola/devtools-ui` | `packages/devtools-ui` | Elm UI components for Timeline, Flow, and Learn views |
2022
| `@wolfcola/devtools-extension` | `packages/devtools-extension` | Browser extension for Chrome and Firefox |
21-
| `@wolfcola/devtools-vscode` | `packages/devtools-vscode` | VS Code extension with CDP connection |
23+
| `oidc-devtools` | `packages/vscode-extension` | VS Code extension with CDP connection |
2224
| `@wolfcola/docs-site` | `packages/docs-site` | This documentation site (elm-pages) |
2325

2426
## Root Files
@@ -52,19 +54,24 @@ The packages have the following dependency relationships:
5254

5355
```
5456
devtools-extension
57+
├── devtools-core
58+
├── devtools-ui (Elm)
5559
└── devtools-types
5660
5761
devtools-bridge
5862
└── devtools-types
5963
60-
devtools-vscode
64+
vscode-extension
65+
└── devtools-types
66+
67+
devtools-core
6168
└── devtools-types
6269
6370
treeshake-check
6471
(standalone)
6572
6673
eslint-plugin-treeshake
67-
(standalone)
74+
(standalone, optional dep on treeshake-check)
6875
```
6976

7077
The `devtools-types` package is the shared foundation. It defines the `AuthEvent` and `FlowState` schemas that the bridge, browser extension, and VS Code extension all depend on.

packages/docs-site/content/docs/devtools-extension.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pnpm install
3030
pnpm --filter @wolfcola/devtools-extension build
3131
```
3232

33-
Then load the unpacked extension from `packages/devtools-extension/dist/` in your browser's extension management page.
33+
Then load the unpacked extension from `packages/devtools-extension/` in your browser's extension management page (the `manifest.json` is in the package root).
3434

3535
## Using the DevTools Panel
3636

@@ -44,7 +44,7 @@ The extension provides three views, accessible via tabs at the top of the panel.
4444

4545
The Timeline view shows a chronological list of every `AuthEvent` emitted by the bridge. Each event displays:
4646

47-
- **Event type** (e.g. `authorize`, `token_exchange`, `refresh`)
47+
- **Event type** (e.g. `sdk:node-change`, `session:cookie`, `sdk:oidc-state`)
4848
- **Timestamp** relative to the page load
4949
- **Payload** expandable JSON tree with the full event data
5050

0 commit comments

Comments
 (0)