Add more comments

src/doc/common/static/jupyter-sphinx-furo.js

@@ -68,13 +68,13 @@ function getQueryParam(param) {
     return urlParams.get(param);
 }
 
-
-// Fetch the versions file and redirect based on the version parameter
+// Fetch the versions.txt file and redirect based on the version parameter
 async function redirectToVersion() {
     let version = getQueryParam("ver");
     let versionMap = {};
 
     try {
+        // TODO: change to https://github.com/sagemath/sage/blob/develop/src/doc/versions.txt
         let response = await fetch('/versions.txt');
         if (!response.ok) {
             throw new Error('Network response was not ok');
@@ -124,7 +124,7 @@ async function redirectToVersion() {
     }
 }
 
-// Redirect if query parameter "ver" is given
+// Redirect if query parameter "ver" is given in url
 redirectToVersion();
 
 // Function to change the version based on versions menu selection
@@ -206,6 +206,3 @@ document.querySelectorAll('input[class="tab-input"]').forEach((elem) => {
         }
     });
 });
-
-
-

src/doc/common/templates-furo/sidebar/version-selector.html

@@ -1,3 +1,3 @@
 <select id="versionsMenu" onchange="changeVersion()">
-    <option value="">Versions</option>
+    <option value="">versions</option>
 </select>

src/doc/versions.txt

@@ -1,4 +1,8 @@
-# This file is maintained by src/bin/sage-update-version script.
+# This file is maintained by src/bin/sage-update-version script
+# The first line is reserved for develop version
+# The other lines are for the most recent stable releases (at most 5 lines)
+# Each line consists of the version and the url to the doc
+# The sage-update-version script adds a new line for a new stable release.
 dev doc-release--sagemath.netlify.app
 10.3 doc-10-3--sagemath.netlify.app
 10.2 doc-10-2--sagemath.netlify.app

src/sage_docbuild/builders.py

@@ -454,6 +454,7 @@ def html(self):
         shutil.copy2(os.path.join(SAGE_DOC_SRC, self.lang, 'website', 'root_index.html'),
                      root_index_file)
 
+        # This versions.txt file is used in src/doc/common/static/jupyter-sphinx-furo.js
         versions_file = os.path.join(SAGE_DOC, 'versions.txt')
         shutil.copy2(os.path.join(SAGE_DOC_SRC, 'versions.txt'), versions_file)