test improved docs

mayank1513 · mayank1513 · commit 7391c92cfd2f · 2025-08-14T05:52:37.000+05:30
diff --git a/docs/constants.md b/docs/constants.md
@@ -13,6 +13,6 @@ nav_order: 2
 
 > `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
 
-Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/constants.ts#L3)
+Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/constants.ts#L3)
 
 const uuid = () =\> (Date.now() \* Math.random()).toString(16).slice(2, 8);
diff --git a/docs/index.md b/docs/index.md
@@ -140,9 +140,9 @@ This library is licensed under the MPL-2.0 open-source license.
 
 - [client/loader-container/loader-container](client/loader-container/loader-container/index.md)
 - [constants](constants.md)
-- [hooks/use-loader](hooks/use-loader.md)
-- [server/bars/bars1/bars1](server/bars/bars1/bars1.md)
-- [server/bars/bars2/bars2](server/bars/bars2/bars2.md)
+- [hooks/use-loader](use-loader.md)
+- [server/bars/bars1/bars1](server/bars/bars1.md)
+- [server/bars/bars2/bars2](server/bars/bars2.md)
 - [server/common/base/base](server/common/base/base/index.md)
-- [server/dots/dots1/dots1](server/dots/dots1/dots1.md)
+- [server/dots/dots1/dots1](server/dots/dots1.md)
 - [server/dots/dots2/dots2](server/dots/dots2/dots2/index.md)
diff --git a/docs/loader-container/-internal-.md b/docs/loader-container/-internal-.md
@@ -12,7 +12,7 @@ nav_order: 6
 
 ### LoaderContainerProps
 
-Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/client/loader-container/loader-container.tsx#L5)
+Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/client/loader-container/loader-container.tsx#L5)
 
 #### Extends
 
@@ -24,7 +24,7 @@ Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/
 
 > `optional` **children**: `ReactNode`
 
-Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/client/loader-container/loader-container.tsx#L6)
+Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/client/loader-container/loader-container.tsx#L6)
 
 ###### Overrides
 
@@ -34,4 +34,4 @@ Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/
 
 > `optional` **loading**: `boolean`
 
-Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/client/loader-container/loader-container.tsx#L7)
+Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/client/loader-container/loader-container.tsx#L7)
diff --git a/docs/loader-container/index.md b/docs/loader-container/index.md
@@ -19,7 +19,7 @@ has_children: true
 
 > **LoaderContainer**(`__namedParameters`): `Element`
 
-Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/client/loader-container/loader-container.tsx#L14)
+Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/client/loader-container/loader-container.tsx#L14)
 
 # LoaderContainer
 
diff --git a/docs/server/bars/bars1.md b/docs/server/bars/bars1.md
@@ -14,7 +14,7 @@ nav_order: 11
 
 > **Bars1**(`props`): `Element`
 
-Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/bars/bars1/bars1.tsx#L10)
+Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/bars/bars1/bars1.tsx#L10)
 
 A simple loader with 3 dots.
 
diff --git a/docs/server/bars/bars2.md b/docs/server/bars/bars2.md
@@ -14,7 +14,7 @@ nav_order: 12
 
 > **Bars2**(`props`): `Element`
 
-Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/bars/bars2/bars2.tsx#L10)
+Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/bars/bars2/bars2.tsx#L10)
 
 A simple loader with 3 dots.
 
diff --git a/docs/server/base/-internal-.md b/docs/server/base/-internal-.md
@@ -12,7 +12,7 @@ nav_order: 15
 
 ### OtherProps
 
-Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L14)
+Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L14)
 
 Other props - loaderClass is included here as we will extend BaseProps for other loaders
 
@@ -22,12 +22,12 @@ Other props - loaderClass is included here as we will extend BaseProps for other
 
 > `optional` **dotRadius**: `string` \| `number`
 
-Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L17)
+Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L17)
 
 ##### loaderClass
 
 > **loaderClass**: `string`
 
-Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L16)
+Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L16)
 
 Loader class name
diff --git a/docs/server/base/index.md b/docs/server/base/index.md
@@ -17,7 +17,7 @@ has_children: true
 
 ### BaseProps
 
-Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L4)
+Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L4)
 
 Interface declaring the common properties of the loaders
 
@@ -35,7 +35,7 @@ Interface declaring the common properties of the loaders
 
 > `optional` **color**: `string`
 
-Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L10)
+Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L10)
 
 Color of the dots - CSS compatible color
 
@@ -47,7 +47,7 @@ Color of the dots - CSS compatible color
 
 > `optional` **height**: `string` \| `number`
 
-Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L8)
+Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L8)
 
 height of the loader element in pixels or a string with a length unit.
 
@@ -59,7 +59,7 @@ height of the loader element in pixels or a string with a length unit.
 
 > `optional` **width**: `string` \| `number`
 
-Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L6)
+Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L6)
 
 width of the loader element in pixels or a string with a length unit.
 
@@ -73,7 +73,7 @@ width of the loader element in pixels or a string with a length unit.
 
 > **Base**(`__namedParameters`): `Element`
 
-Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L25)
+Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L25)
 
 Base component to avoid code duplication
 
diff --git a/docs/server/dots/dots1.md b/docs/server/dots/dots1.md
@@ -14,7 +14,7 @@ nav_order: 18
 
 > **Dots1**(`props`): `Element`
 
-Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/dots/dots1/dots1.tsx#L10)
+Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/dots/dots1/dots1.tsx#L10)
 
 A simple loader with 3 dots.
 
diff --git a/docs/server/dots/dots2/-internal-.md b/docs/server/dots/dots2/-internal-.md
@@ -12,7 +12,7 @@ nav_order: 21
 
 ### Dots2Props
 
-Defined in: [server/dots/dots2/dots2.tsx:4](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/dots/dots2/dots2.tsx#L4)
+Defined in: [server/dots/dots2/dots2.tsx:4](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/dots/dots2/dots2.tsx#L4)
 
 Interface declaring the common properties of the loaders
 
@@ -26,7 +26,7 @@ Interface declaring the common properties of the loaders
 
 > `optional` **color**: `string`
 
-Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L10)
+Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L10)
 
 Color of the dots - CSS compatible color
 
@@ -38,15 +38,15 @@ Color of the dots - CSS compatible color
 
 > `optional` **dotRadius**: `string` \| `number`
 
-Defined in: [server/dots/dots2/dots2.tsx:6](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/dots/dots2/dots2.tsx#L6)
+Defined in: [server/dots/dots2/dots2.tsx:6](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/dots/dots2/dots2.tsx#L6)
 
 Radius of the dots in pixels or a string with a length unit.
 
 ##### height?
 
 > `optional` **height**: `string` \| `number`
 
-Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L8)
+Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L8)
 
 height of the loader element in pixels or a string with a length unit.
 
@@ -58,7 +58,7 @@ height of the loader element in pixels or a string with a length unit.
 
 > `optional` **width**: `string` \| `number`
 
-Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/common/base/base.tsx#L6)
+Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/common/base/base.tsx#L6)
 
 width of the loader element in pixels or a string with a length unit.
 
diff --git a/docs/server/dots/dots2/index.md b/docs/server/dots/dots2/index.md
@@ -19,7 +19,7 @@ has_children: true
 
 > **Dots2**(`props`): `Element`
 
-Defined in: [server/dots/dots2/dots2.tsx:15](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/server/dots/dots2/dots2.tsx#L15)
+Defined in: [server/dots/dots2/dots2.tsx:15](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/server/dots/dots2/dots2.tsx#L15)
 
 A simple loader with 3 dots.
 
diff --git a/docs/use-loader.md b/docs/use-loader.md
@@ -13,7 +13,7 @@ nav_order: 3
 
 > **useLoader**(): `object`
 
-Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/683b4ec36696d89670e076d81eed672b315d9d38/lib/src/hooks/use-loader.ts#L8)
+Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/33300a01e0a383ab39ffb0b6c3c81e46330865b8/lib/src/hooks/use-loader.ts#L8)
 
 #### Returns
 
diff --git a/scripts/add-frontmatter.mjs b/scripts/add-frontmatter.mjs
@@ -166,6 +166,10 @@ function processDir(dir, startOrder = 1, parent = "") {
   return order;
 }
 
+const ModuleTitle = "\n## Modules\n";
+const rootMdFile = path.resolve(DOCS_DIR, "index.md");
+let [staticPart, moduleIndex] = fs.readFileSync(rootMdFile, "utf8").split(ModuleTitle);
+
 function flattenDirs(dir, parent = "") {
   const entries = fs.readdirSync(dir, { withFileTypes: true });
   for (const entry of entries) {
@@ -179,12 +183,17 @@ function flattenDirs(dir, parent = "") {
   if (entries.length === 1 && parent) {
     try {
       // to avoid clash when parent directory has same name.
+      const src = path.resolve(dir, entries[0].name);
       const uuid = crypto.randomUUID();
       const dest = path.resolve(parent, entries[0].name);
       const dest1 = dest + uuid;
-      fs.renameSync(path.resolve(dir, entries[0].name), dest1);
+      fs.renameSync(src, dest1);
       fs.rmdirSync(path.resolve(dir));
       fs.renameSync(dest1, dest);
+      moduleIndex = moduleIndex.replaceAll(
+        `(${path.relative(DOCS_DIR, src).replaceAll(path.sep, "/")})`,
+        `(${path.relative(DOCS_DIR, dest).replaceAll(path.sep, "/")})`,
+      );
     } catch (err) {
       console.error(err);
     }
@@ -193,6 +202,7 @@ function flattenDirs(dir, parent = "") {
 
 // flatten docs output
 flattenDirs(DOCS_DIR);
+fs.writeFileSync(rootMdFile, [staticPart, moduleIndex].join(ModuleTitle));
 
 // Run script
 processDir(DOCS_DIR);
