Merge pull request #3025 from dschnelldavis/2029-make-api-documentati…

…on-more-user-friendly docs(all help files): keep menu on screen
freelawproject · Aug 25, 2023 · 185f1be · 185f1be
2 parents 5f16e9e + 348d2ef
commit 185f1be
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 11 deletions.
diff --git a/cl/api/templates/bulk-data.html b/cl/api/templates/bulk-data.html
@@ -14,7 +14,7 @@
 {% block content %}
 <div class="col-xs-12">
 <div class="row">
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/api/templates/replication.html b/cl/api/templates/replication.html
@@ -8,7 +8,7 @@
 
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/api/templates/rest-docs-vlatest.html b/cl/api/templates/rest-docs-vlatest.html
@@ -13,7 +13,7 @@
 {% endblock %}
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     {% include "includes/toc_sidebar.html" %}
   </div>
   <div class="col-xs-12 col-md-8 col-lg-6">

diff --git a/cl/api/templates/webhooks-docs-vlatest.html b/cl/api/templates/webhooks-docs-vlatest.html
@@ -14,7 +14,7 @@
 {% endblock %}
 
 {% block content %}
-<div class="hidden-xs hidden-sm col-md-3">
+<div id="toc-container" class="hidden-xs hidden-sm col-md-3">
   <div id="toc">
     <h3>Table of Contents</h3>
     <ul>

diff --git a/cl/api/templates/webhooks-getting-started.html b/cl/api/templates/webhooks-getting-started.html
@@ -20,7 +20,7 @@ <h4 class="v-offset-below-2">
   </h4>
 </div>
 
-<div class="hidden-xs hidden-sm col-md-3">
+<div id="toc-container" class="hidden-xs hidden-sm col-md-3">
   <h4 class="v-offset-below-3">
     <i class="fa fa-arrow-circle-o-left gray"></i>
     <a href="{% url "webhooks_docs" %}">Back to Webhooks Docs</a>

diff --git a/cl/assets/static-global/css/override.css b/cl/assets/static-global/css/override.css
@@ -1510,6 +1510,10 @@ textarea {
 #toc > ul > li > ul > li > ul {
   padding-inline-start: 20px;
 }
+#toc-container {
+  position: sticky;
+  top: 0px;
+}
 /* END Webhooks styles */
 
 

diff --git a/cl/simple_pages/templates/contribute.html b/cl/simple_pages/templates/contribute.html
@@ -4,7 +4,7 @@
 {% block sidebar %}{% endblock %}
 
 {% block content %}
-<div class="hidden-xs hidden-sm col-md-3">
+<div id="toc-container" class="hidden-xs hidden-sm col-md-3">
   <div id="toc">
     <h3>Table of Contents</h3>
     <ul>

diff --git a/cl/simple_pages/templates/help/coverage.html b/cl/simple_pages/templates/help/coverage.html
@@ -36,7 +36,7 @@
 {% endblock %}
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/simple_pages/templates/help/coverage_fds.html b/cl/simple_pages/templates/help/coverage_fds.html
@@ -7,7 +7,7 @@
 
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/simple_pages/templates/help/donation_help.html b/cl/simple_pages/templates/help/donation_help.html
@@ -8,7 +8,7 @@
 
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/simple_pages/templates/help/tags_help.html b/cl/simple_pages/templates/help/tags_help.html
@@ -9,7 +9,7 @@
 
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>

diff --git a/cl/simple_pages/templates/terms/latest.html b/cl/simple_pages/templates/terms/latest.html
@@ -4,7 +4,7 @@
 {% block sidebar %}{% endblock %}
 
 {% block content %}
-  <div class="hidden-xs hidden-sm col-md-3">
+  <div id="toc-container" class="hidden-xs hidden-sm col-md-3">
     <div id="toc">
       <h3>Table of Contents</h3>
       <ul>