fix(docs): change side menu's markup from <aside> to <nav> (#2727)

Co-authored-by: Julien Déramond <[email protected]>
Orange-OpenSource · Oct 3, 2024 · 4eb4598 · 4eb4598
1 parent 6b64844
commit 4eb4598
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/site/layouts/_default/docs.html b/site/layouts/_default/docs.html
@@ -1,7 +1,7 @@
 {{ define "body_override" }}<body{{ if (eq .Page.Params.toc true) }} data-bs-spy="scroll" data-bs-target="#TableOfContents"{{ end }}>{{ end }}
 {{ define "main" }}
   <div class="container-xxl bd-gutter mt-3 my-md-4 bd-layout">
-    <aside class="bd-sidebar">
+    <nav class="bd-sidebar" aria-label="Docs navigation">
       <div class="offcanvas-lg offcanvas-start" tabindex="-1" id="bdSidebar" aria-labelledby="bdSidebarOffcanvasLabel">
         <div class="offcanvas-header border-bottom">
           <h5 class="offcanvas-title" id="bdSidebarOffcanvasLabel">Browse docs</h5>
@@ -12,7 +12,7 @@ <h5 class="offcanvas-title" id="bdSidebarOffcanvasLabel">Browse docs</h5>
           {{ partial "docs-sidebar" . }}
         </div>
       </div>
-    </aside>
+    </nav>
 
     <main class="bd-main order-1">
       <div class="bd-intro pt-2 ps-lg-2">

diff --git a/site/layouts/partials/docs-sidebar.html b/site/layouts/partials/docs-sidebar.html
@@ -1,4 +1,4 @@
-<nav class="bd-links w-100" id="bd-docs-nav" aria-label="Docs navigation">
+<div class="bd-links w-100" id="bd-docs-nav">
   {{- $url := split .Permalink "/" -}}
   {{- $page_slug := index $url (sub (len $url) 2) -}}
 
@@ -44,4 +44,4 @@
     {{- end }}
   {{- end }}
   </ul>
-</nav>
+</div>