chore: update documentation

Noelware · Feb 20, 2022 · e0a4e20 · e0a4e20
1 parent 68d7241
commit e0a4e20
Show file tree

Hide file tree

Showing 85 changed files with 5,916 additions and 0 deletions.
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+remi.noelware.org
diff --git a/docs/core/index.html b/docs/core/index.html
@@ -0,0 +1,54 @@
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>core</title>
+</head><body><link href="../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../";</script>
+    <script type="text/javascript" src="../scripts/sourceset_dependencies.js" async></script><link href="../styles/style.css" rel="Stylesheet"><link href="../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../styles/main.css" rel="Stylesheet"><link href="../styles/prism.css" rel="Stylesheet"><link href="../styles/logo-styles.css" rel="Stylesheet"><script type="text/javascript" src="../scripts/clipboard.js" async></script><script type="text/javascript" src="../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../scripts/main.js" defer></script><script type="text/javascript" src="../scripts/prism.js" async></script><script>const storage = localStorage.getItem("dokka-dark-mode")
+const savedDarkMode = storage ? JSON.parse(storage) : false
+if(savedDarkMode === true){
+    document.getElementsByTagName("html")[0].classList.add("theme-dark")
+}</script>
+
+
+    <div class="navigation-wrapper" id="navigation-wrapper">
+      <div id="leftToggler"><span class="icon-toggler"></span></div>
+      <div class="library-name"><a href="../index.html"><span>remi</span></a></div>
+      <div>0.0.1-beta</div>
+      <div class="pull-right d-flex"><button id="theme-toggle-button"><span id="theme-toggle"></span></button>
+        <div id="searchBar"></div>
+      </div>
+    </div>
+    <div id="container">
+      <div id="leftColumn">
+        <div id="sideMenu"></div>
+      </div>
+      <div id="main">
+        <div class="main-content" id="content" pageids="core::////PointingToDeclaration//537371977">
+          <div class="breadcrumbs"></div>
+          <div class="cover ">
+            <h1 class="cover"><span><span>core</span></span></h1>
+          </div>
+          <h2 class="">Packages</h2>
+          <div class="table"><a data-name="2116711553%2FPackages%2F537371977" anchor-label="org.noelware.remi.core" id="2116711553%2FPackages%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
+            <div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/main" data-filterable-set=":core:dokkaHtmlPartial/main">
+              <div>
+                <div class="main-subrow ">
+                  <div class=""><span class="inline-flex">
+                      <div><a href="org.noelware.remi.core/index.html">org.noelware.remi.core</a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2116711553%2FPackages%2F537371977"></span>
+                        <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                      </span></span></div>
+                  <div class="pull-right"></div>
+                </div>
+                <div></div>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
+      </div>
+    </div>
+
+</body></html>
+
+
diff --git a/docs/core/navigation.html b/docs/core/navigation.html
@@ -0,0 +1,97 @@
+<div class="sideMenu"> 
+ <div class="sideMenuPart" id="core-nav-submenu" pageid="core::////PointingToDeclaration//537371977"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;core-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../core/index.html"><span><span>core</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="core-nav-submenu-0" pageid="core::org.noelware.remi.core////PointingToDeclaration//537371977"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;core-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../core/org.noelware.remi.core/index.html"><span>org.</span><wbr><span>noelware.</span><wbr><span>remi.</span><wbr><span>core</span></a>
+   </div> 
+   <div class="sideMenuPart" id="core-nav-submenu-0-0" pageid="core::org.noelware.remi.core/Configuration///PointingToDeclaration//537371977"> 
+    <div class="overview">
+     <a href="../core/org.noelware.remi.core/-configuration/index.html"><span><span>Configuration</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="core-nav-submenu-0-1" pageid="core::org.noelware.remi.core/EmptyConfiguration///PointingToDeclaration//537371977"> 
+    <div class="overview">
+     <a href="../core/org.noelware.remi.core/-empty-configuration/index.html"><span>Empty</span><wbr><span><span>Configuration</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="core-nav-submenu-0-2" pageid="core::org.noelware.remi.core/StorageTrailer///PointingToDeclaration//537371977"> 
+    <div class="overview">
+     <a href="../core/org.noelware.remi.core/-storage-trailer/index.html"><span>Storage</span><wbr><span><span>Trailer</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
+ <div class="sideMenuPart" id="support-fs-nav-submenu" pageid="support-fs::////PointingToDeclaration//2092689821"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;support-fs-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-fs/index.html"><span><span>support-fs</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="support-fs-nav-submenu-0" pageid="support-fs::org.noelware.remi.filesystem////PointingToDeclaration//2092689821"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;support-fs-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-fs/org.noelware.remi.filesystem/index.html"><span>org.</span><wbr><span>noelware.</span><wbr><span>remi.</span><wbr><span>filesystem</span></a>
+   </div> 
+   <div class="sideMenuPart" id="support-fs-nav-submenu-0-0" pageid="support-fs::org.noelware.remi.filesystem/FilesystemStorageConfig///PointingToDeclaration//2092689821"> 
+    <div class="overview">
+     <a href="../support-fs/org.noelware.remi.filesystem/-filesystem-storage-config/index.html"><span>Filesystem</span><wbr><span>Storage</span><wbr><span><span>Config</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="support-fs-nav-submenu-0-1" pageid="support-fs::org.noelware.remi.filesystem/FilesystemStorageTrailer///PointingToDeclaration//2092689821"> 
+    <div class="overview">
+     <a href="../support-fs/org.noelware.remi.filesystem/-filesystem-storage-trailer/index.html"><span>Filesystem</span><wbr><span>Storage</span><wbr><span><span>Trailer</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
+ <div class="sideMenuPart" id="support-s3-nav-submenu" pageid="support-s3::////PointingToDeclaration//-2141002582"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;support-s3-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-s3/index.html"><span><span>support-s3</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="support-s3-nav-submenu-0" pageid="support-s3::org.noelware.remi.s3////PointingToDeclaration//-2141002582"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;support-s3-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-s3/org.noelware.remi.s3/index.html"><span>org.</span><wbr><span>noelware.</span><wbr><span>remi.</span><wbr><span>s3</span></a>
+   </div> 
+   <div class="sideMenuPart" id="support-s3-nav-submenu-0-0" pageid="support-s3::org.noelware.remi.s3/S3Provider///PointingToDeclaration//-2141002582"> 
+    <div class="overview">
+     <span class="navButton" onclick="document.getElementById(&quot;support-s3-nav-submenu-0-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-s3/org.noelware.remi.s3/-s3-provider/index.html"><span><span>S3Provider</span></span></a>
+    </div> 
+    <div class="sideMenuPart" id="support-s3-nav-submenu-0-0-0" pageid="support-s3::org.noelware.remi.s3/S3Provider.Amazon///PointingToDeclaration//-2141002582"> 
+     <div class="overview">
+      <a href="../support-s3/org.noelware.remi.s3/-s3-provider/-amazon/index.html"><span><span>Amazon</span></span></a>
+     </div> 
+    </div> 
+    <div class="sideMenuPart" id="support-s3-nav-submenu-0-0-1" pageid="support-s3::org.noelware.remi.s3/S3Provider.Custom///PointingToDeclaration//-2141002582"> 
+     <div class="overview">
+      <a href="../support-s3/org.noelware.remi.s3/-s3-provider/-custom/index.html"><span><span>Custom</span></span></a>
+     </div> 
+    </div> 
+    <div class="sideMenuPart" id="support-s3-nav-submenu-0-0-2" pageid="support-s3::org.noelware.remi.s3/S3Provider.Wasabi///PointingToDeclaration//-2141002582"> 
+     <div class="overview">
+      <a href="../support-s3/org.noelware.remi.s3/-s3-provider/-wasabi/index.html"><span><span>Wasabi</span></span></a>
+     </div> 
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="support-s3-nav-submenu-0-1" pageid="support-s3::org.noelware.remi.s3/S3StorageConfig///PointingToDeclaration//-2141002582"> 
+    <div class="overview">
+     <a href="../support-s3/org.noelware.remi.s3/-s3-storage-config/index.html"><span>S3Storage</span><wbr><span><span>Config</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="support-s3-nav-submenu-0-2" pageid="support-s3::org.noelware.remi.s3/S3StorageTrailer///PointingToDeclaration//-2141002582"> 
+    <div class="overview">
+     <a href="../support-s3/org.noelware.remi.s3/-s3-storage-trailer/index.html"><span>S3Storage</span><wbr><span><span>Trailer</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+  <div class="sideMenuPart" id="support-s3-nav-submenu-1" pageid="support-s3::org.noelware.remi.s3.internal////PointingToDeclaration//-2141002582"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;support-s3-nav-submenu-1&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../support-s3/org.noelware.remi.s3.internal/index.html"><span>org.</span><wbr><span>noelware.</span><wbr><span>remi.</span><wbr><span>s3.</span><wbr><span>internal</span></a>
+   </div> 
+   <div class="sideMenuPart" id="support-s3-nav-submenu-1-0" pageid="support-s3::org.noelware.remi.s3.internal/AwsRegionSerializer///PointingToDeclaration//-2141002582"> 
+    <div class="overview">
+     <a href="../support-s3/org.noelware.remi.s3.internal/-aws-region-serializer/index.html"><span>Aws</span><wbr><span>Region</span><wbr><span><span>Serializer</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div> 
+</div>
diff --git a/docs/core/org.noelware.remi.core/-configuration/index.html b/docs/core/org.noelware.remi.core/-configuration/index.html
@@ -0,0 +1,57 @@
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>Configuration</title>
+</head><body><link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script>
+    <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><link href="../../../styles/prism.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../../../scripts/main.js" defer></script><script type="text/javascript" src="../../../scripts/prism.js" async></script><script>const storage = localStorage.getItem("dokka-dark-mode")
+const savedDarkMode = storage ? JSON.parse(storage) : false
+if(savedDarkMode === true){
+    document.getElementsByTagName("html")[0].classList.add("theme-dark")
+}</script>
+
+
+    <div class="navigation-wrapper" id="navigation-wrapper">
+      <div id="leftToggler"><span class="icon-toggler"></span></div>
+      <div class="library-name"><a href="../../../index.html"><span>remi</span></a></div>
+      <div>0.0.1-beta</div>
+      <div class="pull-right d-flex"><button id="theme-toggle-button"><span id="theme-toggle"></span></button>
+        <div id="searchBar"></div>
+      </div>
+    </div>
+    <div id="container">
+      <div id="leftColumn">
+        <div id="sideMenu"></div>
+      </div>
+      <div id="main">
+        <div class="main-content" id="content" pageids="core::org.noelware.remi.core/Configuration///PointingToDeclaration//537371977">
+          <div class="breadcrumbs"><a href="../../index.html">core</a>/<a href="../index.html">org.noelware.remi.core</a>/<a href="index.html">Configuration</a></div>
+          <div class="cover ">
+            <h1 class="cover"><span><span>Configuration</span></span></h1>
+            <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">Configuration</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Represents the base configuration for constructing a <a href="../-storage-trailer/index.html">StorageTrailer</a>.</p></div></div>
+          </div>
+          <div class="tabbedcontent">
+            <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Inheritors">Inheritors</button></div>
+            <div class="tabs-section-body">
+              <h2 class="">Inheritors</h2>
+              <div class="table" data-togglable="Inheritors"><a data-name="-1358289960%2FInheritors%2F537371977" anchor-label="EmptyConfiguration" id="-1358289960%2FInheritors%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
+                <div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/main" data-filterable-set=":core:dokkaHtmlPartial/main">
+                  <div class="main-subrow keyValue ">
+                    <div class=""><span class="inline-flex">
+                        <div><a href="../-empty-configuration/index.html">EmptyConfiguration</a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1358289960%2FInheritors%2F537371977"></span>
+                          <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                        </span></span></div>
+                    <div></div>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
+      </div>
+    </div>
+
+</body></html>
+
+
diff --git a/docs/core/org.noelware.remi.core/-empty-configuration/-empty-configuration.html b/docs/core/org.noelware.remi.core/-empty-configuration/-empty-configuration.html
@@ -0,0 +1,39 @@
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>EmptyConfiguration</title>
+</head><body><link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script>
+    <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><link href="../../../styles/prism.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../../../scripts/main.js" defer></script><script type="text/javascript" src="../../../scripts/prism.js" async></script><script>const storage = localStorage.getItem("dokka-dark-mode")
+const savedDarkMode = storage ? JSON.parse(storage) : false
+if(savedDarkMode === true){
+    document.getElementsByTagName("html")[0].classList.add("theme-dark")
+}</script>
+
+
+    <div class="navigation-wrapper" id="navigation-wrapper">
+      <div id="leftToggler"><span class="icon-toggler"></span></div>
+      <div class="library-name"><a href="../../../index.html"><span>remi</span></a></div>
+      <div>0.0.1-beta</div>
+      <div class="pull-right d-flex"><button id="theme-toggle-button"><span id="theme-toggle"></span></button>
+        <div id="searchBar"></div>
+      </div>
+    </div>
+    <div id="container">
+      <div id="leftColumn">
+        <div id="sideMenu"></div>
+      </div>
+      <div id="main">
+        <div class="main-content" id="content" pageids="core::org.noelware.remi.core/EmptyConfiguration/EmptyConfiguration/#/PointingToDeclaration//537371977">
+          <div class="breadcrumbs"><a href="../../index.html">core</a>/<a href="../index.html">org.noelware.remi.core</a>/<a href="index.html">EmptyConfiguration</a>/<a href="-empty-configuration.html">EmptyConfiguration</a></div>
+          <div class="cover ">
+            <h1 class="cover"><span>Empty</span><wbr><span><span>Configuration</span></span></h1>
+          </div>
+          <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-empty-configuration.html"><span class="token function">EmptyConfiguration</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
+        </div>
+        <div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
+      </div>
+    </div>
+
+</body></html>
+
+