Skip to content

Commit e721409

Browse files
committed
chore: drop devframe- prefix from examples and split out Built with page
Rename examples/devframe-{counter,files-inspector,streaming-chat} to examples/{counter,files-inspector,streaming-chat}. Update package.json name/bin, turbo task names, vitest project paths, and README pnpm -C paths to match. Move the "Built with Devframe" showcase from guide/index.md into a dedicated guide/built-with.md page (sidebar entry under Introduction). Fix two broken vitejs/devtools GitHub URLs in the streaming guide and the devframe skill. Internal RPC namespaces, base paths, shared-state keys, channel names, and CLI commands keep the devframe- prefix.
1 parent e5b8fca commit e721409

40 files changed

Lines changed: 42 additions & 37 deletions

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ function listErrorCodes(prefix: string): string[] {
1919
function guideItems(prefix: string): DefaultTheme.NavItemWithLink[] {
2020
return [
2121
{ text: 'Introduction', link: `${prefix}/guide/` },
22+
{ text: 'Built with Devframe', link: `${prefix}/guide/built-with` },
2223
{ text: 'Devframe Definition', link: `${prefix}/guide/devframe-definition` },
2324
{ text: 'RPC', link: `${prefix}/guide/rpc` },
2425
{ text: 'Shared State', link: `${prefix}/guide/shared-state` },

docs/guide/built-with.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Built with Devframe
6+
7+
Real-world devtools shipping on Devframe:
8+
9+
- [**Vite DevTools**](https://devtools.vite.dev/) — the host that bundles multiple devframes into one UI (docks, command palette, terminals). Mount your own definition into it via the [`vite` adapter](/adapters/vite).
10+
- [**ESLint Config Inspector**](https://github.com/eslint/config-inspector) — official ESLint tool for inspecting flat configs.
11+
- [**node-modules-inspector**](https://github.com/antfu/node-modules-inspector) — interactive visualizer for your `node_modules` dependency graph.
12+
13+
End-to-end examples in this repo, exercising the full adapter surface:
14+
15+
- [**counter**](https://github.com/devframes/devframe/tree/main/examples/counter) — smallest possible demo, exercises all adapters.
16+
- [**files-inspector**](https://github.com/devframes/devframe/tree/main/examples/files-inspector) — lists files in cwd via RPC; exercises CLI dev/build/spa surfaces.
17+
- [**streaming-chat**](https://github.com/devframes/devframe/tree/main/examples/streaming-chat) — streams synthetic chat tokens from server to client via `ctx.rpc.streaming`.

docs/guide/index.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,3 @@ Devframe has zero dependencies on Vite or any `@vitejs/*` package — the same d
109109
- [RPC](./rpc) — define type-safe server functions your client can call
110110
- [Agent-Native](./agent-native) — expose your devframe to Claude Desktop, Cursor, or any MCP client
111111

112-
## Built with Devframe
113-
114-
Real-world devtools shipping on Devframe:
115-
116-
- [**Vite DevTools**](https://devtools.vite.dev/) — the host that bundles multiple devframes into one UI (docks, command palette, terminals). Mount your own definition into it via the [`vite` adapter](/adapters/vite).
117-
- [**ESLint Config Inspector**](https://github.com/eslint/config-inspector) — official ESLint tool for inspecting flat configs.
118-
- [**node-modules-inspector**](https://github.com/antfu/node-modules-inspector) — interactive visualizer for your `node_modules` dependency graph.
119-
120-
End-to-end examples in this repo, exercising the full adapter surface:
121-
122-
- [**devframe-counter**](https://github.com/devframes/devframe/tree/main/examples/devframe-counter) — smallest possible demo, exercises all adapters.
123-
- [**devframe-files-inspector**](https://github.com/devframes/devframe/tree/main/examples/devframe-files-inspector) — lists files in cwd via RPC; exercises CLI dev/build/spa surfaces.
124-
- [**devframe-streaming-chat**](https://github.com/devframes/devframe/tree/main/examples/devframe-streaming-chat) — streams synthetic chat tokens from server to client via `ctx.rpc.streaming`.

docs/guide/streaming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,5 +234,5 @@ When you need authoritative state rather than every intermediate value, [shared
234234
## Reference
235235

236236
- API surface: `RpcStreamingHost`, `RpcStreamingChannel<T>`, `StreamSink<T>`, `StreamReader<T>` in `devframe/types`.
237-
- Working example: [`devframe/examples/devframe-streaming-chat`](https://github.com/vitejs/devtools/tree/main/devframe/examples/devframe-streaming-chat).
237+
- Working example: [`examples/streaming-chat`](https://github.com/devframes/devframe/tree/main/examples/streaming-chat).
238238
- Errors: [`DF0029`](../errors/DF0029) (overflow), [`DF0030`](../errors/DF0030) (unknown stream id), [`DF0031`](../errors/DF0031) (write to closed stream), [`DF0032`](../errors/DF0032) (channel name collision).
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "devframe-counter-example",
2+
"name": "counter-example",
33
"type": "module",
44
"version": "0.2.0",
55
"private": true,
66
"description": "Smallest end-to-end devframe demo — exercises all six adapters.",
77
"main": "src/devframe.ts",
88
"bin": {
9-
"devframe-counter": "./bin.mjs"
9+
"counter": "./bin.mjs"
1010
},
1111
"scripts": {
1212
"dev": "node bin.mjs",
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)