Docs: Remove unnecessary h1 tags, add description

cabralpinto · Aug 29, 2023 · f834f30 · f834f30
1 parent e1366b7
commit f834f30
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/docs/src/components/Index.astro b/docs/src/components/Index.astro
@@ -12,7 +12,7 @@ headings[0].text = "Overview";
 <div
   class="hidden xl:block sticky top-8 w-64 pr-16 pt-16 h-full text-sm min-w-fit"
 >
-  <h1 class="font-medium mb-1">On this page</h1>
+  <h2 class="font-medium mb-1">On this page</h2>
   <ul class="index">
     {
       headings.map((heading) => (
@@ -28,7 +28,6 @@ headings[0].text = "Overview";
 
 <script>
   const items = document.querySelectorAll(".index li");
-  const article = document.querySelector("article");
   const headings = document.querySelectorAll("article :is(h1, h2)");
 
   document.addEventListener("scroll", () => {

diff --git a/docs/src/components/Sidebar.astro b/docs/src/components/Sidebar.astro
@@ -21,7 +21,7 @@ const articles = (await Astro.glob("../pages/[!_]*/*.mdx"))
   {
     Object.entries(articles).map(([group, titles]) => (
       <group class="text-sm">
-        <h1 class="font-medium mb-1">{group}</h1>
+        <h2 class="font-medium mb-1">{group}</h2>
         <ul>
           {titles.map(({ title, href }) => (
             <li class="text-gray-600 hover:text-gray-800 hover:font-medium transition-colors w-full">

diff --git a/docs/src/layouts/Layout.astro b/docs/src/layouts/Layout.astro
@@ -28,13 +28,17 @@ const {
       href="/modular-diffusion/images/logo.ico"
     />
     <title>{title} | Modular Diffusion</title>
+    <meta
+      name="description"
+      content="Learn about Modular Diffusion, an easy-to-use Python library for designing and training your own custom Generative Diffusion Models."
+    />
+    <link rel="sitemap" href="/sitemap-index.xml" />
     <link
       rel="stylesheet"
       href="https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css"
       integrity="sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ"
       crossorigin="anonymous"
     />
-    <link rel="sitemap" href="/sitemap-index.xml" />
   </head>
   <body>
     <div class="flex flex-col text-gray-800">