Features still in development
Use the following guidelines to refer to products, features, and APIs that are experimental, pre-release, or in beta.
note
Remember to remove any notes or banners after a product, feature, or API is fully released.
Products and features in beta
Which method you use to label products and features in beta depends on whether your documentation platform indicates that a product is in beta. For example, the Unity Manual and packages use metadata that displays a beta flag in the sidebar and version picker.
Beta products
If your tooling doesn't clearly indicate that a product is in beta, then add the following note banner to the top of the front page of the documentation set:
The current version of
<product>is a beta release. The features and documentation might change between now and the next release.
Beta features in released products
If a released product has a beta feature that doesn't have its own documentation set or page, then add the following note banner immediately after the section header for that feature:
The current version of
<feature>is a beta release. The features and documentation might change between now and the next release.
Experimental products
Use "experimental" to refer to products that are unsupported but still in development. The experimental phase is the first stage of the package lifecycle, during which the product might undergo significant changes. Experimental packages aren't discoverable in the Unity Package Manager, but are occasionally available to users for early feedback through other channels like Unity forums. For more information, refer to Package lifecycle overview.
When you document experimental packages, add the following note banner to the top of the front page of the documentation set:
This package is available as an experimental package, so it's not ready for production use. The features and documentation in this package might change before it's verified for release.
For more information about documenting installation information for experimental packages, refer to Documenting experimental, pre-release, and deprecated packages.
Pre-release products
Use "pre-release" to refer to products that are supported but still in development. Pre-release packages are part of the official product definition. At this point in the package lifecycle, pre-release packages are due to be released by the next Long Term Support (LTS) release of Unity with a stable API. For more information, refer to Package lifecycle overview.
When you document pre-release packages, add the following note banner to the top of the front page of the documentation set:
This package is available as a pre-release package, so it's still in the process of becoming stable enough to release. The features and documentation in this package might change before it's ready for release.
For more information about documenting installation information for pre-release packages, refer to Documenting experimental, pre-release, and deprecated packages.