Add a warning on the internal crates documentation that we don't follow semver

api/sixtyfps-rs/sixtyfps-macros/lib.rs

@@ -10,10 +10,13 @@ LICENSE END */
 
 /*!
 
-*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io).
-This crate should not be used directly by application using SixtyFPS.
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
 You should use the `sixtyfps` crate instead.
 
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 
 // cSpell:ignore punct

sixtyfps_compiler/lib.rs

@@ -10,9 +10,12 @@ LICENSE END */
 /*!
 # The SixtyFPS compiler library
 
-**NOTE:** This library is an internal crate for the SixtyFPS project.
-This crate should not be used directly by application using SixtyFPS.
-You should use the `sixtyfps` crate instead
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
+You should use the `sixtyfps` crate instead.
+
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
 
 */
 

sixtyfps_compiler/parser_test_macro/lib.rs

@@ -15,6 +15,13 @@ function, checking that no error are reported, and that everything was consumed
 
 A parser function must have the signature `fn(&mut impl Parser)`
 
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
+You should use the `sixtyfps` crate instead.
+
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 
 extern crate proc_macro;

sixtyfps_runtime/corelib/lib.rs

@@ -11,10 +11,13 @@ LICENSE END */
 
 # SixtyFPS runtime library
 
-*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io).
-This crate should not be used directly by application using SixtyFPS.
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
 You should use the `sixtyfps` crate instead.
 
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")]
 #![deny(unsafe_code)]

sixtyfps_runtime/corelib_macros/lib.rs

@@ -9,7 +9,15 @@
 LICENSE END */
 /*!
     This crate contains the internal procedural macros
-    used by the sixtyfps corelib crate
+    used by the sixtyfps-corelib crate
+
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
+You should use the `sixtyfps` crate instead.
+
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 
 extern crate proc_macro;

sixtyfps_runtime/rendering_backends/default/lib.rs

@@ -8,16 +8,21 @@
     Please contact info@sixtyfps.io for more information.
 LICENSE END */
 /*!
+
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
+You should use the `sixtyfps` crate instead.
+
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
+
 The purpose of this crate is to select the default backend for [SixtyFPS](https://sixtyfps.io)
 
 The backend can either be a runtime or a build time decision.  The runtime decision is decided
 by the `SIXTYFPS_BACKEND` environment variable. The built time default depends on the platform.
 In order for the crate to be available at runtime, they need to be added as feature
 
-*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io).
-This crate should not be used directly by application using SixtyFPS.
-You should use the `sixtyfps` crate instead.
-
 */
 #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")]
 

sixtyfps_runtime/rendering_backends/gl/lib.rs

@@ -9,10 +9,13 @@
 LICENSE END */
 /*!
 
-*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io).
-This crate should not be used directly by application using SixtyFPS.
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
 You should use the `sixtyfps` crate instead.
 
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")]
 

sixtyfps_runtime/rendering_backends/qt/lib.rs

@@ -10,10 +10,13 @@ LICENSE END */
 
 /*!
 
-*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io).
-This crate should not be used directly by application using SixtyFPS.
+**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io).
+This crate should **not be used directly** by applications using SixtyFPS.
 You should use the `sixtyfps` crate instead.
 
+**WARNING**: This crate does not follow the semver convention for versioning and can
+only be used with `version = "=x.y.z"` in Cargo.toml.
+
 */
 #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")]
 #![recursion_limit = "1024"]