📚 Subject area/topic
Experimental Features
📋 Page(s) affected (or suggested, for new content)
📋 Description of content that is out-of-date or incorrect
Some features that have previously been added to Astro were first introduced as experimental.
In doing so, the addition of these features was documented as experimental when first introduced.
After the features were moved from experimental to officially supported, the documentation became inconsistent.
In the case of View Transitions, the transition:persist directive is documented to be introduced in astro@2.10.0. However, at this time, this would have been experimental.
- Should this be documented as
astro@3.0.0, which was when the featured moved out of experimental?
In Astro Assets, the <Image /> component doesn't have a "since", while the <Picture /> tag is documented as astro@3.3.0. Moreover, some documented properties of the Image component are flagged as experimental, added in 3.3.0.
- How should docs handle documenting when something is experimental and when it moves from experimental to official support?
Essentially, the documentation doesn't account for when something was experimental (if applicable). Those using older versions may believe that a feature is available when it was only experimental then.
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)
No response
📚 Subject area/topic
Experimental Features
📋 Page(s) affected (or suggested, for new content)
Sinceis current, but doesn't mention experimental.https://docs.astro.build/en/guides/view-transitions/
<Image />and<Picture />) - InconsistentSincehttps://docs.astro.build/en/guides/images/
https://docs.astro.build/en/guides/content-collections/
export const prerender = true | false) - NoSincehttps://docs.astro.build/en/guides/server-side-rendering/#opting-in-to-pre-rendering-in-server-mode
Sincehttps://docs.astro.build/en/reference/configuration-reference/#dev-toolbar-options
📋 Description of content that is out-of-date or incorrect
Some features that have previously been added to Astro were first introduced as
experimental.In doing so, the addition of these features was documented as
experimentalwhen first introduced.After the features were moved from
experimentalto officially supported, the documentation became inconsistent.In the case of View Transitions, the
transition:persistdirective is documented to be introduced inastro@2.10.0. However, at this time, this would have beenexperimental.astro@3.0.0, which was when the featured moved out ofexperimental?In Astro Assets, the
<Image />component doesn't have a "since", while the<Picture />tag is documented asastro@3.3.0. Moreover, some documented properties of theImagecomponent are flagged as experimental, added in3.3.0.Essentially, the documentation doesn't account for when something was experimental (if applicable). Those using older versions may believe that a feature is available when it was only experimental then.
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)
No response