GITBOOK-192: Mark Vite support as experimental

electron-forge · Sep 21, 2024 · af58e3e · af58e3e
1 parent fe28804
commit af58e3e
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -43,10 +43,10 @@
 
 ## Built-in Templates <a href="#templates" id="templates"></a>
 
-* [Vite](templates/vite.md)
-* [Vite + TypeScript](templates/vite-+-typescript.md)
 * [Webpack](templates/webpack-template.md)
 * [Webpack + Typescript](templates/typescript-+-webpack-template.md)
+* [Vite](templates/vite.md)
+* [Vite + TypeScript](templates/vite-+-typescript.md)
 
 ## Guides
 

diff --git a/config/plugins/vite.md b/config/plugins/vite.md
@@ -4,6 +4,12 @@ description: Transform and bundle code for your Electron Forge app with Vite.
 
 # Vite Plugin
 
+{% hint style="info" %}
+As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\
+\
+For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0).
+{% endhint %}
+
 This plugin makes it easy to set up standard Vite tooling to compile both your main process code and your renderer process code.
 
 ## Installation

diff --git a/templates/vite-+-typescript.md b/templates/vite-+-typescript.md
@@ -1,5 +1,11 @@
 # Vite + TypeScript
 
+{% hint style="info" %}
+As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\
+\
+For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0).
+{% endhint %}
+
 To get you up and running as fast as possible with [TypeScript](https://www.typescriptlang.org/) and [Vite](https://vitejs.dev/), we provide a template that makes use of the [`@electron-forge/plugin-vite` module](../config/plugins/vite.md) with sane TypeScript configuration defaults.
 
 ```bash

diff --git a/templates/vite.md b/templates/vite.md
@@ -4,6 +4,12 @@ description: Create a new Electron app with Vite.
 
 # Vite
 
+{% hint style="info" %}
+As of Electron Forge v7.5.0, Vite support for Electron Forge has been marked as **experimental** in order to reflect its stage in development and to provide maintainers with the ability to release fixes and improvements rapidly. Future minor releases may contain breaking changes, but migration steps will be listed in release notes.\
+\
+For more context, see the Electron Forge [v7.5.0 release notes](https://github.com/electron/forge/releases/tag/v7.5.0).
+{% endhint %}
+
 To get you up and running as fast as possible with [Vite](https://vitejs.dev/), we provide a template that makes use of the [`@electron-forge/plugin-vite` module](../config/plugins/vite.md), plus some preset Vite configuration options.
 
 ```bash