Refreshes Retype-generated documentation.

Process triggered by patricklafrance.
workleap · Jan 8, 2024 · 328dbca · 328dbca
1 parent 3aafa81
commit 328dbca
Show file tree

Hide file tree

Showing 78 changed files with 997 additions and 516 deletions.
diff --git a/404.html b/404.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="turbo-root" content="/wl-squide">
-    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.755366638104">
+    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.758041665711">
 
     <!-- See retype.com -->
     <meta name="generator" content="Retype 3.5.0">
@@ -29,11 +29,11 @@
     <script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
 
     <link href="/wl-squide/static/favicon.png" rel="icon">
-    <link href="/wl-squide/resources/css/retype.css?v=3.5.0.755366638104" rel="stylesheet">
+    <link href="/wl-squide/resources/css/retype.css?v=3.5.0.758041665711" rel="stylesheet">
 
-    <script data-cfasync="false" src="/wl-squide/resources/js/config.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script data-cfasync="false" src="/wl-squide/resources/js/config.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
     <script data-cfasync="false" src="/wl-squide/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
-    <script id="lunr-js" data-cfasync="false" src="/wl-squide/resources/js/lunr.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script id="lunr-js" data-cfasync="false" src="/wl-squide/resources/js/lunr.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
 
     <link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />
 

diff --git a/about/index.html b/about/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="turbo-root" content="/wl-squide">
-    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.755366638104">
+    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.758041665711">
 
     <!-- See retype.com -->
     <meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
     <script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
 
     <link href="../static/favicon.png" rel="icon">
-    <link href="../resources/css/retype.css?v=3.5.0.755366638104" rel="stylesheet">
+    <link href="../resources/css/retype.css?v=3.5.0.758041665711" rel="stylesheet">
 
-    <script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
     <script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
-    <script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
 
     <link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />
 
@@ -343,7 +343,7 @@ <h2>
                                         </li>
                                     </ul>
                                 </div>
-                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2023 - Workleap</p></div>
+                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2024 - Workleap</p></div>
                             </footer>
                         </div>
                     </div>

diff --git a/getting-started/create-host/index.html b/getting-started/create-host/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="turbo-root" content="/wl-squide">
-    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.755366638104">
+    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.758041665711">
 
     <!-- See retype.com -->
     <meta name="generator" content="Retype 3.5.0">
@@ -32,12 +32,12 @@
     <script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
 
     <link href="../../static/favicon.png" rel="icon">
-    <link href="../../resources/css/retype.css?v=3.5.0.755366638104" rel="stylesheet">
+    <link href="../../resources/css/retype.css?v=3.5.0.758041665711" rel="stylesheet">
 
-    <script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
     <script data-cfasync="false" src="../../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
-    <script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
-    <script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.755366638104" defer></script>
+    <script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
+    <script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.758041665711" defer></script>
 
     <link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />
 
@@ -514,14 +514,14 @@ <h3>
     );
 }</code></pre>
 </doc-codeblock></div>
-<p>In the previous code sample, the <code v-pre>RootLayout</code> will serves as the default layout for the homepage as well as for every page (route) registered by a module that are not nested under a parent route with either the <a href="../../reference/runtime/runtime-class/#register-nested-routes-under-an-existing-route">parentPath</a> or the <a href="../../reference/runtime/runtime-class/#register-a-named-route">parentName</a> option.</p>
+<p>The <code v-pre>RootLayout</code> component created in the previous sample will serves as the default layout for the homepage as well as for every page (route) registered by a module that are not nested under a parent route with either the <a href="../../reference/runtime/runtime-class/#register-nested-routes-under-an-existing-route">parentPath</a> or the <a href="../../reference/runtime/runtime-class/#register-a-named-route">parentName</a> option.</p>
 <doc-anchor-target id="homepage">
     <h3>
         <doc-anchor-trigger class="header-anchor-trigger" to="#homepage">#</doc-anchor-trigger>
         <span>Homepage</span>
     </h3>
 </doc-anchor-target>
-<p>Next, create the <code v-pre>HomePage</code> component that will serve as the homepage for this application:</p>
+<p>Next, create the <code v-pre>HomePage</code> component that will serve as the homepage:</p>
 <div class="codeblock-wrapper"><doc-codeblock>
 <div class="codeblock-title">host/src/HomePage.tsx</div>
 <pre class="language-tsx"><code v-pre class="language-tsx">export function HomePage() {
@@ -582,7 +582,7 @@ <h3>
             </svg>
         </div>
         <div class="pr-5 ml-3 w-full">
-<p>The <a href="../../reference/routing/managedroutes/">ManagedRoutes</a> placeholder indicates where routes that are neither hoisted or nested with a <a href="../../reference/runtime/runtime-class/#register-nested-navigation-items">parentPath</a> or <a href="../../reference/runtime/runtime-class/#register-a-named-route">parentName</a> option will be rendered. In this example, the homepage route is considered a managed route and will be rendered under the <code v-pre>ManagedRoutes</code> placeholder.</p>
+<p>The <a href="../../reference/routing/managedroutes/">ManagedRoutes</a> placeholder indicates where routes that are neither hoisted or nested with a <a href="../../reference/runtime/runtime-class/#register-nested-navigation-items">parentPath</a> or <a href="../../reference/runtime/runtime-class/#register-a-named-route">parentName</a> option will be rendered. In this example, the homepage route is considered as a managed route and will be rendered under the <code v-pre>ManagedRoutes</code> placeholder.</p>
         </div>
     </div>
 </div>
@@ -699,7 +699,7 @@ <h3>
 });</code></pre>
 </doc-codeblock></div>
 <blockquote>
-<p>If you are having issues with the wepack configuration that are not related to module federation, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/webpack/configure-dev/" class="outbound" target="_blank">@workleap/webpack-configs documentation</a>.</p>
+<p>If you are having issues with the wepack configuration that are not related to module federation, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/webpack/configure-dev/" class="outbound" target="_blank">@workleap/webpack-configs</a> documentation.</p>
 </blockquote>
 <doc-anchor-target id="build-configuration">
     <h3>
@@ -736,7 +736,7 @@ <h3>
 });</code></pre>
 </doc-codeblock></div>
 <blockquote>
-<p>If you are having issues with the wepack configuration that are not related to module federation, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/webpack/configure-build/" class="outbound" target="_blank">@workleap/webpack-configs documentation</a>.</p>
+<p>If you are having issues with the wepack configuration that are not related to module federation, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/webpack/configure-build/" class="outbound" target="_blank">@workleap/webpack-configs</a> documentation.</p>
 </blockquote>
 <doc-anchor-target id="add-cli-scripts">
     <h2>
@@ -764,7 +764,7 @@ <h2>
         <span>Try it <span class="docs-emoji">&#x1F680;</span></span>
     </h2>
 </doc-anchor-target>
-<p>Start the application in a development environment using the <code v-pre>dev</code> script. You should see the home page. Even if the remote module application is not yet available, the host application will gracefully load.</p>
+<p>Start the application in a development environment using the <code v-pre>dev</code> script. You should see the homepage. Even if the remote module application is not yet available, the host application will gracefully (and ignore the remote module).</p>
 <doc-anchor-target id="troubleshoot-issues">
     <h3>
         <doc-anchor-trigger class="header-anchor-trigger" to="#troubleshoot-issues">#</doc-anchor-trigger>
@@ -849,7 +849,7 @@ <h3>
                                         </li>
                                     </ul>
                                 </div>
-                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2023 - Workleap</p></div>
+                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2024 - Workleap</p></div>
                             </footer>
                         </div>
                     </div>

diff --git a/getting-started/create-local-module/index.html b/getting-started/create-local-module/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="turbo-root" content="/wl-squide">
-    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.755366638104">
+    <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.758041665711">
 
     <!-- See retype.com -->
     <meta name="generator" content="Retype 3.5.0">
@@ -32,12 +32,12 @@
     <script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
 
     <link href="../../static/favicon.png" rel="icon">
-    <link href="../../resources/css/retype.css?v=3.5.0.755366638104" rel="stylesheet">
+    <link href="../../resources/css/retype.css?v=3.5.0.758041665711" rel="stylesheet">
 
-    <script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
+    <script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
     <script data-cfasync="false" src="../../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
-    <script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.755366638104" data-turbo-eval="false" defer></script>
-    <script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.755366638104" defer></script>
+    <script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.758041665711" data-turbo-eval="false" defer></script>
+    <script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.758041665711" defer></script>
 
     <link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />
 
@@ -306,7 +306,7 @@ <h1>
     </h1>
 </doc-anchor-target>
 <p>Local modules are regular modules that are part of the <strong>host application build</strong>. They are independent modules that expose a <code v-pre>registration</code> function to the host application&#x27;s bootstrapping code. A local module can be a standalone package, a sibling project (in a monorepo setup), or even a local folder within the host application.</p>
-<p>Local modules are useful when <strong>migrating</strong> from a <strong>monolithic application</strong> to a distributed application or when <strong>launching</strong> a <strong>new product</strong> with an unrefined business domain.</p>
+<p>Local modules have many uses but are especially useful when <strong>migrating</strong> from a <strong>monolithic application</strong> to a distributed application or when <strong>launching</strong> a <strong>new product</strong> with an unrefined business domain.</p>
 <p>Let&#x27;s add a local module to demonstrate how it&#x27;s done!</p>
 <blockquote>
 <p>Loading remote modules at runtime with <a href="https://webpack.js.org/concepts/module-federation/" class="outbound" target="_blank">Module Federation</a> is the primary focus of this shell and our recommended approach. It empowers teams to be <strong>fully autonomous</strong> by <strong>deploying</strong> their modules <strong>independently</strong> from the other parts of the application.</p>
@@ -438,7 +438,7 @@ <h2>
         <span>Register the local module</span>
     </h2>
 </doc-anchor-target>
-<p>Go back to the <code v-pre>host</code> application add a dependency to the <code v-pre>@sample/local-module</code> package in the host application <code v-pre>package.json</code> file:</p>
+<p>Go back to the <code v-pre>host</code> application and add a dependency to the <code v-pre>@sample/local-module</code> package in the host application <code v-pre>package.json</code> file:</p>
 <div class="codeblock-wrapper"><doc-codeblock>
 <div class="codeblock-title">host/package.json</div>
 <pre class="language-json"><code v-pre class="language-json">{
@@ -453,7 +453,7 @@ <h2>
 <pre class="language-tsx" data-line="4,26"><code v-pre class="language-tsx">import { createRoot } from &quot;react-dom/client&quot;;
 import { ConsoleLogger, RuntimeContext, FireflyRuntime, registerRemoteModules, type RemoteDefinition } from &quot;@squide/firefly&quot;;
 import type { AppContext } from &quot;@sample/shared&quot;;
-import { register as registerLocalModule } from &quot;@sample/local-module&quot;;
+import { register as registerMyLocalModule } from &quot;@sample/local-module&quot;;
 import { App } from &quot;./App.tsx&quot;;
 
 // Define the remote modules.
@@ -475,7 +475,7 @@ <h2>
 await registerRemoteModules(Remotes, runtime, context);
 
 // Register the local module.
-registerLocalModule([registerLocalModule], runtime, context);
+registerLocalModule([registerMyLocalModule], runtime, context);
 
 const root = createRoot(document.getElementById(&quot;root&quot;));
 
@@ -504,7 +504,7 @@ <h2>
             </svg>
         </div>
         <div class="pr-5 ml-3 w-full">
-<p>If you are having issues with the tsup configuration, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/tsup" class="outbound" target="_blank">@workleap/tsup-configs documentation</a>.</p>
+<p>If you are having issues with the tsup configuration, refer to the <a href="https://gsoft-inc.github.io/wl-web-configs/tsup" class="outbound" target="_blank">@workleap/tsup-configs</a> documentation.</p>
         </div>
     </div>
 </div>
@@ -641,7 +641,7 @@ <h3>
                                         </li>
                                     </ul>
                                 </div>
-                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2023 - Workleap</p></div>
+                                <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2024 - Workleap</p></div>
                             </footer>
                         </div>
                     </div>