Fix some doc navigation issues

rvesse · Nov 27, 2023 · 8146ce4 · 8146ce4
1 parent f3cccdb
commit 8146ce4
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,4 @@ docs/find.xslt
 docs/maven-metadata.xml
 docs/.bundle/
 docs/vendor/
+docs/.jekyll-metadata
diff --git a/docs/404.html b/docs/404.html
@@ -6,5 +6,10 @@
 
 <div class="page">
   <h1 class="page-title">404: Page not found</h1>
-  <p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{ site.baseurl }}">Head back home</a> to try finding it again.</p>
+  <p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{
+  site.baseurl }}">Head back home</a> to try finding it again.</p>
+  <p>
+    If you were looking for Javadoc the module you've selected may not have existed in the Airline release you have
+    selected.
+  </p>
 </div>
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -130,6 +130,8 @@ side_nav:
                       url: "require-only-one.html"
                     - text: "@MutuallyExclusiveWith"
                       url: "mutually-exclusive-with.html"
+                    - text: "@RequiredUnlessEnvironment"
+                      url: "required-unless.html"
                 - text: "Occurrence Restrictions"
                   kind: Group
                   items:

diff --git a/docs/_includes/javadoc-nav.html b/docs/_includes/javadoc-nav.html
@@ -1,11 +1,15 @@
         <ul>
           <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline/">Core API</a></li>
           <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-io/">IO API</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-man/">Man Help</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-markdown/">Markdown Help</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-html/">HTML Help</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-bash/">Bash Help</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-external/">External Help</a></li>
-          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-jpms-resources/">JPMS Resource Locator</a></li>
           <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-prompts/">Prompts API</a></li>
-         </ul>
+          <li><a href="#">Help Modules</a>
+            <ul>
+              <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-man/">Man Help</a></li>
+              <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-markdown/">Markdown Help</a></li>
+              <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-html/">HTML Help</a></li>
+              <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-bash/">Bash Help</a></li>
+              <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-help-external/">External Help</a></li>
+            </ul>
+          </li>
+          <li><a href="{{ site.baseurl }}/javadoc/{{ include.version }}/airline-jpms-resources/">JPMS Resource Locator</a></li>
+        </ul>
diff --git a/docs/_includes/nav-fragment.html b/docs/_includes/nav-fragment.html
@@ -23,7 +23,7 @@
     </li>
   {% elsif navitem.kind == "Javadoc" %}
     <li>
-      <a href="#">{{ javadoc }}</a>
+      <a href="#">{{ navitem.version }}</a>
       {% include javadoc-nav.html version=navitem.version %}
     </li>
   {% else %}