improve visibility of api-docs generation

oqtane · Dec 5, 2024 · 318dcbb · 318dcbb
1 parent 4ae71c9
commit 318dcbb
Show file tree

Hide file tree

Showing 13 changed files with 645 additions and 1,270 deletions.
diff --git a/docs/api/Oqtane.html b/docs/api/Oqtane.html
@@ -2,9 +2,9 @@
 <html>
   <head>
     <meta charset="utf-8">
-      <title>Namespace Oqtane | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
+      <title>Oqtane Namespace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <meta name="title" content="Namespace Oqtane | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
+      <meta name="title" content="Oqtane Namespace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
 
 
       <link rel="icon" href="../layout/images/favicon.png">
@@ -89,7 +89,8 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
   <h1 id="Oqtane" data-uid="Oqtane" class="text-break">Namespace Oqtane</h1>
   <div class="markdown level0 summary"></div>
   <div class="markdown level0 conceptual">
-<p>TODO: Please document what this namespace is for.</p>
+<p>This is the main namespace for Oqtane.</p>
+<p>It only contains a few shared resources / constants, the rest is in other namespaces.</p>
 </div>
   <div class="markdown level0 remarks"></div>
 

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api/index.md/#L1">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/pages/api/index.md/#L1">
       <meta name="loc:inThisArticle" content="In this article">
       <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
       <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
@@ -84,15 +84,17 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
           <nav id="breadcrumb"></nav>
         </div>
 
-        <article data-uid="">
+        <article data-uid="Oqtane.Api.Home">
 <h1 id="oqtane-api-documentation">Oqtane API Documentation</h1>
 
 <div class="NOTE">
 <h5>Note</h5>
 <p>The API documentation is still work-in-progress.</p>
+<p>We need your 🫵🏽 help to make it better 😉.</p>
 </div>
 <h2 id="colors-and-icons">Colors and Icons</h2>
-<p>APIs can be daunting. Because of this, we've color-coded the menu to the left and added icons to make it easier for you to get around.</p>
+<p>APIs can be daunting.
+So we color-coded the menu to the left and added icons to make it easier for you to get around.</p>
 <div class="NOTE">
 <h5>Note</h5>
 <p>This is what the colors and icons in the TOC mean:</p>
@@ -106,7 +108,7 @@ <h5>Note</h5>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api/index.md/#L1" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/pages/api/index.md/#L1" class="edit-link">Edit this page</a>
         </div>
 
         <div class="next-article d-print-none border-top" id="nextArticle"></div>

diff --git a/docs/index.html b/docs/index.html
@@ -83,7 +83,7 @@ <h2 id="documentation-contents">Documentation Contents</h2>
 </li>
 <li><p>The <a href="manuals/index.html">Administration Manuals</a> is WIP</p>
 </li>
-<li><p>In the <a href="api/index.html">API Documentation</a> you'll find all the APIs</p>
+<li><p>In the <a class="xref" href="api/index.html">API Documentation</a> you'll find all the APIs</p>
 </li>
 <li><p>To work on the docs, better read up on <a href="dev/docs/index.html">how the docs work</a></p>
 </li>

diff --git a/docs/index.json b/docs/index.json