Skip to content

Commit 10e5992

Browse files
antfuclaude
andauthored
docs: rebrand as devtools framework with dedicated Rolldown section (#250)
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 210d826 commit 10e5992

8 files changed

Lines changed: 107 additions & 46 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const SocialLinks = [
3232
// https://vitepress.dev/reference/site-config
3333
export default extendConfig(withMermaid(defineConfig({
3434
title: 'Vite DevTools',
35-
description: 'Visualize and analyze your Vite build process with powerful developer tools. Extensible architecture for building custom DevTools integrations.',
35+
description: 'An extensible devtools framework for the Vite ecosystem. Build, compose, and integrate developer tools with a unified foundation.',
3636
head: [
3737
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
3838
],
@@ -42,6 +42,12 @@ export default extendConfig(withMermaid(defineConfig({
4242
// https://vitepress.dev/reference/default-theme-config
4343
nav: [
4444
{ text: 'Guide', link: '/guide/' },
45+
{
46+
text: 'Builtin DevTools',
47+
items: [
48+
{ text: 'DevTools for Rolldown', link: '/rolldown/' },
49+
],
50+
},
4551
{
4652
text: 'DevTools Kit',
4753
items: DevToolsKitNav,
@@ -60,7 +66,13 @@ export default extendConfig(withMermaid(defineConfig({
6066
text: 'Guide',
6167
items: [
6268
{ text: 'Getting Started', link: '/guide/' },
63-
{ text: 'Features', link: '/guide/features/' },
69+
],
70+
},
71+
{
72+
text: 'DevTools for Rolldown',
73+
items: [
74+
{ text: 'Introduction', link: '/rolldown/' },
75+
{ text: 'Features', link: '/rolldown/features' },
6476
],
6577
},
6678
{
@@ -98,7 +110,7 @@ export default extendConfig(withMermaid(defineConfig({
98110
title: 'Vite DevTools',
99111
items: [
100112
{ text: 'Guide', link: '/guide/' },
101-
{ text: 'Features', link: '/guide/features' },
113+
{ text: 'DevTools for Rolldown', link: '/rolldown/' },
102114
{ text: 'Release Notes', link: 'https://github.com/vitejs/devtools/releases' },
103115
{ text: 'Contributing', link: 'https://github.com/vitejs/devtools/blob/main/CONTRIBUTING.md' },
104116
],
@@ -107,6 +119,12 @@ export default extendConfig(withMermaid(defineConfig({
107119
title: 'DevTools Kit',
108120
items: DevToolsKitNav,
109121
},
122+
{
123+
title: 'Builtin DevTools',
124+
items: [
125+
{ text: 'DevTools for Rolldown', link: '/rolldown/' },
126+
],
127+
},
110128
],
111129
social: SocialLinks,
112130
},

docs/.vitepress/theme/Home.vue

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ import Spacer from '@components/shared/Spacer.vue'
1111

1212
<HeadingSection
1313
heading="Inspect, Analyze, Extend"
14-
subheading="Vite DevTools not only provides built-in features, but also a extensible architecture for custom integrations."
14+
subheading="Vite DevTools provides an extensible framework with built-in integrations like DevTools for Rolldown, plus an open architecture for custom tools."
1515
/>
1616

1717
<FeatureGrid />
1818

1919
<Spacer />
2020

2121
<Footer
22-
heading="Understand your Vite App Better"
23-
subheading="Visually inspect modules, plugins, chunks, assets, packages..." button-text="Get Started"
22+
heading="Understand Your Vite Ecosystem Better"
23+
subheading="Inspect builds, analyze performance, extend with custom integrations..." button-text="Get Started"
2424
button-link="/guide/"
2525
/>
2626
</template>

docs/guide/index.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,33 @@ outline: deep
44

55
# Getting Started
66

7-
> [!WARNING]
8-
> Vite DevTools currently only supports build mode of Vite 8+.
9-
> Dev mode and Vite versions under 8 are not supported yet.
10-
117
## What is Vite DevTools?
128

13-
Vite DevTools is a comprehensive set of developer tools for visualizing and analyzing your Vite build process. It provides deep insights into your build pipeline, module dependencies, and build metadata, helping you understand and optimize your Vite applications.
9+
Vite DevTools is a devtools framework for the Vite ecosystem. Instead of each tool building its own devtools from scratch, Vite DevTools provides shared infrastructure — a unified dock system, type-safe RPC, shared state management, and flexible UI hosting — so that different tools compose together seamlessly, users get a consistent experience, and tool authors can focus on what makes their integration unique.
10+
11+
Any Vite plugin can hook into Vite DevTools with just a few lines of code, instantly gaining access to the full platform: panels, action buttons, server-client communication, and more.
12+
13+
### Built-in Integrations
14+
15+
- **[DevTools for Rolldown](/rolldown/)** — Build analysis, module graphs, chunks, assets, plugins, and performance insights
16+
- **DevTools for Vite** — Vite-specific developer tools *(in development)*
17+
18+
### Ecosystem
19+
20+
Vite DevTools Kit is already powering a growing ecosystem of integrations:
21+
22+
- **[Nuxt DevTools v4](https://github.com/nuxt/devtools)** — Built on top of Vite DevTools Kit
23+
- **[Oxc Inspector](https://github.com/yuyinws/oxc-inspector)** — Integrates via DevTools Kit with custom RPC functions
24+
- **[UnoCSS Inspector](https://github.com/unocss/unocss)** — Dock integration for UnoCSS
25+
- **[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** — Action button that triggers a DOM inspector
1426

1527
### Key Features
1628

17-
- **🔍 Build Analysis**: Visualize module graphs, dependencies, and build metadata
18-
- **📊 Performance Insights**: Understand build performance and bottlenecks
19-
- **🧩 Extensible**: Build custom DevTools integrations with the DevTools Kit
29+
- **🧩 Extensible Framework**: Any Vite plugin can extend the devtools with a simple hook
30+
- **🔍 [DevTools for Rolldown](/rolldown/)**: Built-in build analysis with module graphs, dependencies, and build metadata
2031
- **🎨 Unified Interface**: All DevTools integrations appear in a consistent dock interface
21-
- **⚡ Type-Safe**: Full TypeScript support with type-safe RPC communication
32+
- **🔌 Type-Safe RPC**: Built-in bidirectional communication between server and client
33+
- **⚡ Shared State**: Automatic synchronization of data between server and client
2234

2335
## Installation
2436

@@ -129,26 +141,28 @@ When `build.withApp` is enabled, running `pnpm build` will automatically generat
129141

130142
Now that you have Vite DevTools set up, you can:
131143

132-
- **Explore the built-in tools**: Check out the various panels and visualizations available in the DevTools interface
133-
- **Build custom integrations**: Learn how to extend Vite DevTools with your own tools using the [DevTools Kit](/kit/)
144+
- **Explore the built-in tools**: Check out the [DevTools for Rolldown](/rolldown/) panels and visualizations
145+
- **Build custom integrations**: Learn how to extend the devtools with your own tools using the [Vite DevTools Kit](/kit/)
134146
- **Contribute**: Help improve Vite DevTools by checking out our [contributing guide](https://github.com/antfu/contribute)
135147

136148
## Current Limitations
137149

138150
> [!NOTE]
139-
> Vite DevTools is currently in active development with the following limitations:
151+
> Vite DevTools is currently in active development.
140152
141-
- **Build mode only**: Currently works with Vite-Rolldown's build mode
142-
- **Dev mode**: Not yet supported (planned for future releases)
143-
- **Vite Version**: Requires Vite 8 or higher versions for now
153+
- **[DevTools for Rolldown](/rolldown/)**: Currently supports build mode only, requires Vite 8+
154+
- **Dev mode**: Dev mode support is planned for future releases
144155

145156
## Architecture Overview
146157

147158
Vite DevTools consists of several core packages:
148159

149-
- **`@vitejs/devtools`**: The main entry point and CLI
150-
- **`@vitejs/devtools-kit`**: Utilities and types for building custom integrations
151-
- **`@vitejs/devtools-rolldown`**: Built-in UI panel for Rolldown
160+
- **`@vitejs/devtools`**: The core framework, CLI, and runtime hosts
161+
- **`@vitejs/devtools-kit`**: Vite DevTools Kit — utilities and types for building custom integrations
162+
- **`@vitejs/devtools-rolldown`**: [DevTools for Rolldown](/rolldown/) — built-in build analysis UI
163+
- **`@vitejs/devtools-vite`**: DevTools for Vite *(in development)*
152164
- **`@vitejs/devtools-rpc`**: RPC layer for server-client communication
153165

154-
For more details on extending Vite DevTools, see the [DevTools Kit documentation](/kit/).
166+
Third-party integrations like [Oxc Inspector](https://github.com/yuyinws/oxc-inspector) can also integrate via the DevTools Kit plugin API.
167+
168+
For more details on extending the devtools, see the [Vite DevTools Kit documentation](/kit/).

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ theme: dark
44

55
hero:
66
name: Vite DevTools
7-
text: DevTools for Vite.
8-
tagline: Visualize and analyze your Vite build process with powerful developer tools
7+
text: DevTools Framework for the Vite Ecosystem.
8+
tagline: An extensible foundation for building and composing developer tools across the Vite ecosystem
99
actions:
1010
- theme: brand
1111
text: Get Started
@@ -19,11 +19,11 @@ hero:
1919

2020
features:
2121
- icon: 🔍
22-
title: Build Analysis
23-
details: Deep insights into your Vite-Rolldown build process. Visualize module graphs, dependencies, and build metadata to understand what's happening under the hood.
22+
title: DevTools for Rolldown
23+
details: Built-in integration for Rolldown build analysis. Visualize module graphs, dependencies, chunks, assets, and build metadata.
2424
- icon: 🧩
2525
title: Extensible Architecture
26-
details: Build custom DevTools integrations with the DevTools Kit. Extend any Vite plugin with a simple devtools hook to add your own visualizations and tools.
26+
details: Build custom DevTools integrations with the DevTools Kit. Any Vite plugin can extend the devtools with a simple hook to add visualizations, inspectors, and tools.
2727
- icon: 🚀
2828
title: Unified Dock System
2929
details: A familiar dock interface (like macOS Dock) where all DevTools integrations appear together. Switch between tools seamlessly in a consistent UI.

docs/kit/examples.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ outline: deep
44

55
# Examples
66

7+
## Demo Examples
8+
79
A collection of example plugins built with `@vitejs/devtools-kit` that demonstrate different features and patterns.
810

9-
## A11y Checker
11+
### A11y Checker
1012

1113
An accessibility auditing plugin powered by [axe-core](https://github.com/dequelabs/axe-core).
1214

@@ -19,7 +21,7 @@ An accessibility auditing plugin powered by [axe-core](https://github.com/dequel
1921

2022
**Source:** [`examples/plugin-a11y-checker`](https://github.com/vitejs/devtools/tree/main/examples/plugin-a11y-checker)
2123

22-
## File Explorer
24+
### File Explorer
2325

2426
A file explorer dock that lists, reads, and writes files through RPC.
2527

@@ -33,7 +35,7 @@ A file explorer dock that lists, reads, and writes files through RPC.
3335

3436
**Source:** [`examples/plugin-file-explorer`](https://github.com/vitejs/devtools/tree/main/examples/plugin-file-explorer)
3537

36-
## Git UI
38+
### Git UI
3739

3840
An interactive Git panel built entirely with server-side JSON specs — no client code at all.
3941

@@ -47,3 +49,13 @@ An interactive Git panel built entirely with server-side JSON specs — no clien
4749
- Updating dock badge text reactively
4850

4951
**Source:** [`examples/plugin-git-ui`](https://github.com/vitejs/devtools/tree/main/examples/plugin-git-ui)
52+
53+
## Real-World Examples
54+
55+
The docs might not cover all the details—please help us improve them by submitting PRs. In the meantime, refer to these existing DevTools integrations:
56+
57+
- **[UnoCSS Inspector](https://github.com/unocss/unocss/blob/25c0dd737132dc20b257c276ee2bc3ccc05e2974/packages-integrations/inspector/src/index.ts#L140-L150)** - A simple iframe-based dock entry
58+
- **[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** - An action button that triggers a DOM inspector
59+
- [Plugin hook](https://github.com/antfu/vite-plugin-vue-tracer/blob/9f86fe723543405eea5d30588fe783796193bfd8/src/plugin.ts#L139-L157)
60+
- [Client script](https://github.com/antfu/vite-plugin-vue-tracer/blob/main/src/client/vite-devtools.ts)
61+
- **[Oxc Inspector](https://github.com/yuyinws/oxc-inspector/blob/main/src/vite.ts)** - An iframe-based dock entry with custom RPC functions

docs/kit/index.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,4 @@ If you're building a Vite plugin and want to add DevTools capabilities, or if yo
100100
4. **[Shared State](./shared-state)** - Share data between server and client with automatic synchronization
101101

102102
> [!TIP] Help Us Improve
103-
> If you are building something on top of Vite DevTools, we invite you to label your repository with `vite-devtools` on GitHub to help us track usage and improve the project. Thank you!
104-
105-
## Real-World Examples
106-
107-
The docs might not cover all the details—please help us improve them by submitting PRs. In the meantime, refer to these existing DevTools integrations:
108-
109-
- **[UnoCSS Inspector](https://github.com/unocss/unocss/blob/25c0dd737132dc20b257c276ee2bc3ccc05e2974/packages-integrations/inspector/src/index.ts#L140-L150)** - A simple iframe-based dock entry
110-
- **[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** - An action button that triggers a DOM inspector
111-
- [Plugin hook](https://github.com/antfu/vite-plugin-vue-tracer/blob/9f86fe723543405eea5d30588fe783796193bfd8/src/plugin.ts#L139-L157)
112-
- [Client script](https://github.com/antfu/vite-plugin-vue-tracer/blob/main/src/client/vite-devtools.ts)
113-
- **[Oxc Inspector](https://github.com/yuyinws/oxc-inspector/blob/main/src/vite.ts)** - An iframe-based dock entry with custom RPC functions
103+
> If you are building something on top of Vite DevTools Kit, we invite you to label your repository with `vite-devtools` on GitHub to help us track usage and improve the project. Thank you!
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
outline: deep
33
---
44

5-
# Features
5+
# DevTools for Rolldown
66

7-
Discover all the features Vite Devtools offers.
7+
DevTools for Rolldown provides comprehensive build analysis for Vite projects using Rolldown. Explore modules, chunks, assets, plugins, and more.
88

99
## Overview
1010

docs/rolldown/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# DevTools for Rolldown
6+
7+
DevTools for Rolldown (`@vitejs/devtools-rolldown`) is a built-in integration that provides comprehensive build analysis for Vite projects using Rolldown. It comes included with Vite DevTools out of the box.
8+
9+
> [!WARNING]
10+
> DevTools for Rolldown currently only supports build mode of Vite 8+.
11+
> Dev mode and Vite versions under 8 are not supported yet.
12+
13+
## What It Does
14+
15+
DevTools for Rolldown gives you deep insights into your Rolldown-powered build process:
16+
17+
- **Module Analysis** — Visualize module graphs, dependencies, and transformation flows
18+
- **Plugin Insights** — Inspect plugin hook costs and processed modules
19+
- **Chunk & Asset Analysis** — Explore build output with list, graph, treemap, and flamegraph views
20+
- **Package Detection** — Detect duplicated packages and analyze dependency sizes
21+
- **Session Compare** — Compare bundle changes across builds
22+
23+
See the [Features](/rolldown/features) page for a detailed walkthrough with screenshots.
24+
25+
## Getting Started
26+
27+
DevTools for Rolldown is automatically available when you set up Vite DevTools. Follow the [Getting Started](/guide/) guide to install and configure Vite DevTools, then the Rolldown build analysis panels will appear in the dock.

0 commit comments

Comments
 (0)