improve structure of API docs

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

Hide file tree

Showing 32 changed files with 117 additions and 107 deletions.
diff --git a/docs/api/Oqtane.Controllers.html b/docs/api/Oqtane.Controllers.html
@@ -2,9 +2,9 @@
 <html>
   <head>
     <meta charset="utf-8">
-      <title>Namespace Oqtane.Controllers | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
+      <title>Oqtane Controllers 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.Controllers | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
+      <meta name="title" content="Oqtane Controllers Namespace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
 
 
       <link rel="icon" href="../layout/images/favicon.png">
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Controllers/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Controllers/index.md/#L2">
       <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;">
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
   <h1 id="Oqtane_Controllers" data-uid="Oqtane.Controllers" class="text-break">Namespace Oqtane.Controllers</h1>
   <div class="markdown level0 summary"></div>
   <div class="markdown level0 conceptual">
-<p>TODO: Please document what this namespace is for.</p>
+<p>WebAPI Controllers provided by Oqtane.</p>
 </div>
   <div class="markdown level0 remarks"></div>
 
@@ -236,7 +236,7 @@ <h3 id="structs">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Controllers/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Controllers/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Documentation.PrivateApi.html b/docs/api/Oqtane.Documentation.PrivateApi.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Documentation/PrivateApi.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Documentation/PrivateApi.md/#L2">
       <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;">

diff --git a/docs/api/Oqtane.Documentation.PublicApi.html b/docs/api/Oqtane.Documentation.PublicApi.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Documentation/PublicApi.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Documentation/PublicApi.md/#L2">
       <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;">

diff --git a/docs/api/Oqtane.Documentation.html b/docs/api/Oqtane.Documentation.html
@@ -2,9 +2,9 @@
 <html>
   <head>
     <meta charset="utf-8">
-      <title>Namespace Oqtane.Documentation | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
+      <title>Oqtane Documentation 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.Documentation | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
+      <meta name="title" content="Oqtane Documentation Namespace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
 
 
       <link rel="icon" href="../layout/images/favicon.png">
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Documentation/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Documentation/index.md/#L2">
       <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;">
@@ -90,36 +90,37 @@ <h1 id="Oqtane_Documentation" data-uid="Oqtane.Documentation" class="text-break"
   <div class="markdown level0 summary"></div>
   <div class="markdown level0 conceptual">
 <p>This namespace contains attributes like <code>PublicApi</code> which mark code as public, private, internal, etc.
-Depending on what attributes you add to your code it will appear in the generated docs - and possibly have a warning or something attached.</p>
+Depending on what attributes you add to your code it will appear in the generated docs,
+and possibly have a warning or something attached.</p>
 <p>Typical use:</p>
 <pre><code class="lang-cs">[PublicApi]
 public class YourClass {
-	// this will be documented without any special comments
-	// because we're not using the &lt;summary&gt; tag
-	public string Name;
-
-    /// &lt;summary&gt;
-    /// This will be documented with this text in the summary
-    /// &lt;/summary&gt;
-	public string Something;
-
-    /// &lt;summary&gt;
-	/// This won't appear in the public documentation
-    /// &lt;/summary&gt;
-	[PrivateApi(&quot;Don't publish this - should only be used internally&quot;)]
-	public string InternalSpecialName;
-
-    /// &lt;summary&gt;
-	/// This will appear in the docs, but the Work-In-Progress will be clearly visible
-    /// &lt;/summary&gt;
-	[WorkInProgressApi(&quot;We're not done yet, may change&quot;)]
-	public string NotDoneYet;
-
-    /// &lt;summary&gt;
-	/// This will appear in the docs, but with a warning
-    /// &lt;/summary&gt;
-	[InternalApi_DoNotUse_MayChangeWithoutNotice(&quot;This may help you, but please don't use it&quot;)]
-	public string YouShouldKnowAboutThisButNotUseIt;
+  // this will be documented without any special comments
+  // because we're not using the &lt;summary&gt; tag
+  public string Name;
+
+  /// &lt;summary&gt;
+  /// This will be documented with this text in the summary
+  /// &lt;/summary&gt;
+  public string Something;
+
+  /// &lt;summary&gt;
+  /// This won't appear in the public documentation
+  /// &lt;/summary&gt;
+  [PrivateApi(&quot;Don't publish this - should only be used internally&quot;)]
+  public string InternalSpecialName;
+
+  /// &lt;summary&gt;
+  /// This will appear in the docs, but Work-In-Progress is clearly visible
+  /// &lt;/summary&gt;
+  [WorkInProgressApi(&quot;We're not done yet, may change&quot;)]
+  public string NotDoneYet;
+
+  /// &lt;summary&gt;
+  /// This will appear in the docs, but with a warning
+  /// &lt;/summary&gt;
+  [InternalApi_DoNotUse_MayChangeWithoutNotice(&quot;This may help you, but please don't use it&quot;)]
+  public string YouShouldKnowAboutThisButNotUseIt;
 }
 </code></pre>
 </div>
@@ -158,7 +159,7 @@ <h3 id="classes">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Documentation/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Documentation/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Enums.html b/docs/api/Oqtane.Enums.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Enums/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Enums/index.md/#L2">
       <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;">
@@ -109,7 +109,7 @@ <h3 id="enums">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Enums/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Enums/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Extensions.html b/docs/api/Oqtane.Extensions.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Extensions/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Extensions/index.md/#L2">
       <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;">
@@ -149,7 +149,7 @@ <h3 id="classes">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Extensions/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Extensions/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Infrastructure.html b/docs/api/Oqtane.Infrastructure.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Infrastructure/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Infrastructure/index.md/#L2">
       <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;">
@@ -296,7 +296,7 @@ <h3 id="interfaces">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Infrastructure/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Infrastructure/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Models.html b/docs/api/Oqtane.Models.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Models/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Models/index.md/#L2">
       <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;">
@@ -364,7 +364,7 @@ <h3 id="interfaces">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Models/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Models/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Modules.Controls.html b/docs/api/Oqtane.Modules.Controls.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Modules/Controls/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Modules/Controls/index.md/#L2">
       <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;">
@@ -177,7 +177,7 @@ <h3 id="classes">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Modules/Controls/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Modules/Controls/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Modules.html b/docs/api/Oqtane.Modules.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Modules/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Modules/index.md/#L2">
       <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;">
@@ -165,7 +165,7 @@ <h3 id="enums">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Modules/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Modules/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.Services.html b/docs/api/Oqtane.Services.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Services/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Services/index.md/#L2">
       <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;">
@@ -291,7 +291,7 @@ <h3 id="interfaces">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Services/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Services/index.md/#L2" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/Oqtane.html b/docs/api/Oqtane.html
@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="../">
 
 
-      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Octane/index.md/#L2">
+      <meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Octane/index.md/#L2">
       <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;">
@@ -191,7 +191,7 @@ <h3 id="classes">
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/apidoc/Octane/index.md/#L2" class="edit-link">Edit this page</a>
+          <a href="https://github.com/oqtane/oqtane.docs/blob/master/src/api-docs/Octane/index.md/#L2" class="edit-link">Edit this page</a>
         </div>