Several improvements to "First 3D Game" tutorial

.github/workflows/build_offline_docs.yml

@@ -13,6 +13,7 @@ jobs:
       matrix:
         branch:
           - master
+          - stable
           - 3.6
     steps:
       - uses: actions/checkout@v4
@@ -29,7 +30,7 @@ jobs:
       - name: Sphinx - Build HTML
         run: make SPHINXOPTS='--color' html
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: godot-docs-html-${{ matrix.branch }}
           path: _build/html
@@ -51,7 +52,7 @@ jobs:
 
           make SPHINXOPTS='--color' epub
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: godot-docs-epub-${{ matrix.branch }}
           path: _build/epub/GodotEngine.epub

.github/workflows/sync_class_ref.yml

@@ -51,7 +51,7 @@ jobs:
           ./.engine-src/doc/tools/make_rst.py --color -o ./classes -l en ./.engine-src/doc/classes ./.engine-src/modules ./.engine-src/platform
 
       - name: Submit a pull-request
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           commit-message: 'classref: Sync with current ${{ env.engine_rev }} branch (${{ steps.engine.outputs.rev_hash_short }})'
           branch: 'classref/sync-${{ steps.engine.outputs.rev_hash_short }}'

_extensions/godot_descriptions.py

@@ -103,10 +103,11 @@ def generate_description(app, pagename, templatename, context, doctree):
     doctree.walkabout(generator)
 
     description = (
-        '<meta name="description" content="' + generator.create_description() + '">\n'
+        '<meta name="description" content="' + generator.create_description() + '" />\n'
     )
 
-    context["metatags"] += description
+    if not '<meta name="description"' in context["metatags"]:
+        context["metatags"] += description
 
 
 def setup(app):

_static/css/custom.css

@@ -360,7 +360,8 @@ article ol,
 }
 
 body,
-.rst-content table.docutils thead {
+.rst-content table.docutils thead,
+.rst-content table.docutils caption {
     color: var(--body-color);
 }
 
@@ -1763,3 +1764,8 @@ p + .classref-constant {
         padding: 3px 5px;
     }
 }
+
+/* Giscus */
+#godot-giscus {
+    margin-bottom: 1em;
+}

_static/js/custom.js

@@ -238,6 +238,65 @@ const registerSidebarObserver = (function(){
   };
 })();
 
+/**
+ * Registers Giscus if there's an #godot-giscus container.
+ * @returns {void} Nothing.
+ */
+const registerGiscus = function () {
+  const giscusContainer = document.getElementById("godot-giscus");
+  if (giscusContainer == null) {
+    return;
+  }
+
+  const removeGiscusContainer = function() {
+    giscusContainer.remove();
+  };
+
+  const pageNameMetaElement = Array.from(document.head.querySelectorAll("meta")).find((meta) => meta.name === "doc_pagename");
+  if (pageNameMetaElement == null) {
+    removeGiscusContainer();
+    return;
+  }
+
+  const pageNameDenyList = [
+    "search"
+  ];
+  if (pageNameDenyList.includes(pageNameMetaElement.content)) {
+    removeGiscusContainer();
+    return;
+  }
+
+  // Use https://giscus.app/ to regenerate the script tag if needed.
+  // data-term is set to be language-independent and version-independent, so that comments can be centralized for each page.
+  // This increases the likelihood that users will encounter comments on less frequently visited pages.
+  const scriptElement = document.createElement("script");
+  scriptElement.src = "https://giscus.app/client.js";
+  scriptElement.crossOrigin = "anonymous";
+  scriptElement.async = true;
+
+  const dataset = {
+    repo: "godotengine/godot-docs-user-notes",
+    repoId: "R_kgDOKuNx0w",
+    category: "User-contributed notes",
+    categoryId: "DIC_kwDOKuNx084CbANb",
+    mapping: "specific",
+    term: pageNameMetaElement.content,
+    strict: "1",
+    reactionsEnabled: "0",
+    emitMetadata: "0",
+    inputPosition: "bottom",
+    theme: "preferred_color_scheme",
+    lang: "en",
+    loading: "lazy",
+  };
+
+  for (const [key, value] of Object.entries(dataset)) {
+    scriptElement.dataset[key] = value;
+  }
+
+  giscusContainer.append(scriptElement);
+};
+
 $(document).ready(() => {
   // Remove the search match highlights from the page, and adjust the URL in the
   // navigation history.
@@ -246,6 +305,17 @@ $(document).ready(() => {
     Documentation.hideSearchWords();
   }
 
+  window.addEventListener('keydown', function(event) {
+    if (event.key === '/') {
+        var searchField = document.querySelector('#rtd-search-form input[type=text]');
+        if (document.activeElement !== searchField) {
+            searchField.focus();
+            searchField.select();
+            event.preventDefault();
+        }
+    }
+  });
+
   // Initialize handlers for page scrolling and our custom sidebar.
   const mediaQuery = window.matchMedia('only screen and (min-width: 769px)');
 
@@ -414,6 +484,9 @@ $(document).ready(() => {
 
     registerOnScrollEvent(mediaQuery);
   }
+
+  // Giscus
+  registerGiscus();
 });
 
 // Override the default implementation from doctools.js to avoid this behavior.