docs: fix previous and next links in the getting started section (#766)

versini-org · Dec 18, 2024 · 0b2ee5d · 0b2ee5d
1 parent 7db8ca3
commit 0b2ee5d
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 6 deletions.
diff --git a/packages/api/src/getting-started/Changelogs.mdx b/packages/api/src/getting-started/Changelogs.mdx
@@ -55,5 +55,5 @@ import SystemChangelog from "../../../ui-system/CHANGELOG.md?raw";
 <Unstyled>
   <div className="mt-4" />
 </Unstyled>
-  <Navigators leftLink="Release Tags" />
+  <Navigators leftLabel="Release Tags" />
 </div>
diff --git a/packages/api/src/getting-started/Configuration.mdx b/packages/api/src/getting-started/Configuration.mdx
@@ -35,6 +35,6 @@ import codeBlocks from "../helpers/codeBlocks";
       />
     </div>
 
-    <Navigators leftLink="Installation" rightLink="Usage" />
+    <Navigators leftLabel="Installation" rightLabel="Usage" />
 
   </div>
diff --git a/packages/api/src/getting-started/Installation.mdx b/packages/api/src/getting-started/Installation.mdx
@@ -60,6 +60,6 @@ import tableData from "../helpers/tableData";
     		</small>
     	</p>
 
-    <Navigators leftLink="Overview" rightLink="Configuration" />
+    <Navigators leftLabel="Overview" rightLabel="Configuration" />
 
   </div>
diff --git a/packages/api/src/getting-started/Overview.mdx b/packages/api/src/getting-started/Overview.mdx
@@ -23,7 +23,7 @@ import Navigators from "../helpers/Navigators";
     </div>
     <div className="p-4">
       <blockquote>The UI Components Library provides a strong, responsive, and accessible set of foundational React components.</blockquote>
-      <Navigators rightLink="Installation" />
+      <Navigators rightLabel="Installation" />
     </div>
 
   </div>

diff --git a/packages/api/src/getting-started/ReleaseTags.mdx b/packages/api/src/getting-started/ReleaseTags.mdx
@@ -93,7 +93,7 @@ import Navigators from "../helpers/Navigators";
     	</ul>
 
     <div className="mt-8">
-      <Navigators leftLink="Usage" rightLink="Changelogs" />
+      <Navigators leftLabel="Usage" rightLabel="Changelogs" />
     </div>
 
   </div>
diff --git a/packages/api/src/getting-started/Usage.mdx b/packages/api/src/getting-started/Usage.mdx
@@ -30,6 +30,6 @@ import codeBlocks from "../helpers/codeBlocks";
       <p>Hello World</p>
     </Card>
 
-      <Navigators leftLink="Configuration" rightLink="Release Tags" paddingTop />
+      <Navigators leftLabel="Configuration" rightLabel="Release Tags" paddingTop />
 
   </div>
diff --git a/packages/api/src/helpers/Navigators.tsx b/packages/api/src/helpers/Navigators.tsx
@@ -28,6 +28,21 @@ export default ({
 		| "space-evenly"
 		| undefined = "flex-end";
 
+	/**
+	 * If the label is provided but the link is not, we generate the link from the label,
+	 * by replacing spaces with dashes and converting to lowercase, and adding "--docs" at the end,
+	 * and getting-started- at the beginning.
+	 * Example: "Release Tags" -> "getting-started-release-tags--docs"
+	 *
+	 * This is the default for the main "getting started" pages.
+	 */
+	if (leftLabel && !leftLink) {
+		leftLink = `getting-started-${leftLabel.replace(/\s+/g, "-").toLowerCase()}--docs`;
+	}
+	if (rightLabel && !rightLink) {
+		rightLink = `getting-started-${rightLabel.replace(/\s+/g, "-").toLowerCase()}--docs`;
+	}
+
 	if (leftLink && rightLink) {
 		mainAlign = "space-between";
 	} else if (leftLink) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -35,6 +35,6 @@ import codeBlocks from "../helpers/codeBlocks"; @@
           />
         </div>
-        <Navigators leftLink="Installation" rightLink="Usage" />
+        <Navigators leftLabel="Installation" rightLabel="Usage" />
       </div>