From 99a993219ef2db986da1174295929a86173eb8d4 Mon Sep 17 00:00:00 2001
From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
Date: Fri, 16 Jan 2026 00:54:46 -0500
Subject: [PATCH]  docs: remove HTML comments causing banner gap to show 
 (#1958)

* docs: remove HTML comments causing banner gap to show

Turns out the HTML comments get rendered, which causes an unsightly bar
to show up where the banner is even when not nightly.

* add comments back but use jinja comments

See: https://tedboy.github.io/jinja2/templ5.html

* add more context
---
 .gitignore               | 4 +++-
 docs/overrides/main.html | 4 ++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 85be5b63..70c7da6b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -28,8 +28,10 @@ sample_configs/testing*.toml
 # Cargo-deny
 deny.toml
 
-# vscode
+# Editors
 .vscode
+.zed
+.idea
 
 # mkdocs
 site/
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
index cb23fe08..c6ef225f 100644
--- a/docs/overrides/main.html
+++ b/docs/overrides/main.html
@@ -1,8 +1,8 @@
 {% extends "base.html" %}
 {% block announce %}
-    <!-- It's like helm and you need to add dashes, see https://github.com/squidfunk/mkdocs-material/discussions/5803#discussioncomment-7690065 -->
+    {#- It's like helm and you need to add dashes, see https://github.com/squidfunk/mkdocs-material/discussions/5803#discussioncomment-7690065; note that _Jinja_ comments need to be used, not HTML -#}
     {%- if config.extra.nightly -%}
-    <!-- Need to reapply margin from base CSS, which is overridden in extra CSS (to fix empty banner) -->
+    {#- Need to reapply margin from base CSS, which is overridden in extra CSS (to fix empty banner) -#}
     <div style="margin: 0.6rem auto">
         This is <strong>nightly</strong> documentation, and it may differ from stable. Please see <strong><a href="{{ '../' ~ base_url }}">here for stable documentation</a></strong>.
     </div>