added banner for unreleased docs (#2682)

Author: Rahban1

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 * Added anchor links to admonition blocks, making it possible to create direct links to specific admonitions. ([#2505], [#2676])
+* Added different banners for dev and unreleased docs ([#2382], [#2682])
+
 ## Fixed
 
 * `@meta`, `@setup`, and `@docs` blocks no longer generate spurious entries in the search index. ([#1929], [#2675])

assets/html/scss/documenter/components/_warner.scss

@@ -1,14 +1,11 @@
-// outdated-docs warning overlay
-.outdated-warning-overlay {
+// Base warning overlay styles
+.warning-overlay-base {
   position: fixed;
   top: 0;
   left: 0;
   right: 0;
   box-shadow: 0 0 10px rgba(0,0,0,0.3);
   z-index: 999;
-  background-color: map-get($admonition-background, 'danger');
-  color: map-get($admonition-body-color, 'danger');
-  border-bottom: 3px solid map-get($admonition-header-background, 'danger');
   padding: 10px 35px;
   text-align: center;
   font-size: 15px;
@@ -27,4 +24,20 @@
       color: $link-hover;
     }
   }
+}
+
+// outdated-docs warning overlay (for older versions)
+.outdated-warning-overlay {
+  @extend .warning-overlay-base;
+  background-color: map-get($admonition-background, 'danger');
+  color: map-get($admonition-body-color, 'danger');
+  border-bottom: 3px solid map-get($admonition-header-background, 'danger');
+}
+
+// dev-docs warning overlay (for development versions)
+.dev-warning-overlay {
+  @extend .warning-overlay-base;
+  background-color: map-get($admonition-background, 'warning');
+  color: map-get($admonition-body-color, 'warning');
+  border-bottom: 3px solid map-get($admonition-header-background, 'warning');
 }

assets/html/themes/catppuccin-frappe.css

@@ -1,7 +1,7 @@
 function maybeAddWarning() {
   // DOCUMENTER_NEWEST is defined in versions.js, DOCUMENTER_CURRENT_VERSION and DOCUMENTER_STABLE
-  // in siteinfo.js.
-  // If either of these are undefined something went horribly wrong, so we abort.
+  // in siteinfo.js. DOCUMENTER_IS_DEV_VERSION is optional and defined in siteinfo.js.
+  // If the required variables are undefined something went horribly wrong, so we abort.
   if (
     window.DOCUMENTER_NEWEST === undefined ||
     window.DOCUMENTER_CURRENT_VERSION === undefined ||
@@ -30,17 +30,33 @@ function maybeAddWarning() {
   }
 
   const div = document.createElement("div");
-  div.classList.add("outdated-warning-overlay");
+  // Base class is added by default
+  div.classList.add("warning-overlay-base");
   const closer = document.createElement("button");
   closer.classList.add("outdated-warning-closer", "delete");
   closer.addEventListener("click", function () {
     document.body.removeChild(div);
   });
   const href = window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
-  div.innerHTML =
-    'This documentation is not for the latest stable release, but for either the development version or an older release.<br><a href="' +
+
+  // Determine if this is a development version or an older release
+  let warningMessage = "";
+  if (window.DOCUMENTER_IS_DEV_VERSION === true) {
+    div.classList.add("dev-warning-overlay");
+    warningMessage =
+      "This documentation is for the <strong>development version</strong> and may contain unstable or unreleased features.<br>";
+  } else {
+    div.classList.add("outdated-warning-overlay");
+    warningMessage =
+      "This documentation is for an <strong>older version</strong> that may be missing recent changes.<br>";
+  }
+
+  warningMessage +=
+    '<a href="' +
     href +
     '">Click here to go to the documentation for the latest stable release.</a>';
+
+  div.innerHTML = warningMessage;
   div.appendChild(closer);
   document.body.appendChild(div);
 }

assets/html/themes/catppuccin-latte.css

@@ -424,7 +424,9 @@ function git_push(
             HTMLWriter.generate_siteinfo_file(deploy_dir, nothing)
         else
             # Generate siteinfo-file with DOCUMENTER_CURRENT_VERSION
-            HTMLWriter.generate_siteinfo_file(deploy_dir, subfolder)
+            # Determine if this is a development version (e.g., "dev" or "latest")
+            is_dev_version = (subfolder == devurl || subfolder == "latest")
+            HTMLWriter.generate_siteinfo_file(deploy_dir, subfolder, is_dev_version)
 
             # Expand the users `versions` vector
             entries, symlinks = HTMLWriter.expand_versions(dirname, versions)