feat: sorted sidebar + move everything over

ublue-os · Dec 9, 2024 · 0395a91 · 0395a91
1 parent 04e7983
commit 0395a91
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 197 deletions.
diff --git a/docs/Documentation/introduction.md b/docs/Documentation/introduction.md
diff --git a/docs/Documentation/FAQ.md → docs/FAQ.md b/docs/Documentation/FAQ.md → docs/FAQ.md
@@ -14,7 +14,7 @@ Everything you need is included.
 Other than the visual differences, and codecs, there are some other key differences between Bluefin and Fedora Silverblue from a usage perspective:
 
 - Bluefin takes a [greenfield approach](https://en.wikipedia.org/wiki/Greenfield_project) to Linux applications by defaulting to Flathub and `brew` by default
-- Bluefin doesn't recommend using Toolbx - it instead focuses on [devcontainers](/Documentation/bluefin-dx.md#the-cloud-native-development-approach) for declarative containerized development.
+- Bluefin doesn't recommend using Toolbx - it instead focuses on [devcontainers](/bluefin-dx.md#the-cloud-native-development-approach) for declarative containerized development.
 - Bluefin _tries_ to remove the need for the user to use `rpm-ostree` or `bootc` directly
 - Bluefin focuses on automation of OS services and upgrades instead of user interaction
 

diff --git a/docs/Documentation/administration.md → docs/administration.md b/docs/Documentation/administration.md → docs/administration.md
diff --git a/docs/Documentation/ai.md → docs/ai.md b/docs/Documentation/ai.md → docs/ai.md
diff --git a/docs/Documentation/bluefin-dx.md → docs/bluefin-dx.md b/docs/Documentation/bluefin-dx.md → docs/bluefin-dx.md
diff --git a/docs/Contributing/contributing.md → docs/contributing.md b/docs/Contributing/contributing.md → docs/contributing.md
@@ -1,4 +1,5 @@
 ---
+title: Contributor's guide
 slug: /contributing
 ---
 

diff --git a/docs/Supporting The Project/donations.md → docs/donations.md b/docs/Supporting The Project/donations.md → docs/donations.md
diff --git a/docs/Framework Laptops/framework-13.md → docs/framework-13.md b/docs/Framework Laptops/framework-13.md → docs/framework-13.md
diff --git a/docs/Framework Laptops/framework-16.md → docs/framework-16.md b/docs/Framework Laptops/framework-16.md → docs/framework-16.md
diff --git a/docs/Framework Laptops/framework.md → docs/framework.md b/docs/Framework Laptops/framework.md → docs/framework.md
diff --git a/docs/Contributing/local.md → docs/local.md b/docs/Contributing/local.md → docs/local.md
diff --git a/docs/Documentation/press-kit.md → docs/press-kit.md b/docs/Documentation/press-kit.md → docs/press-kit.md
diff --git a/docs/T2 Macs (2018-2020)/t2-mac.md → docs/t2-mac.md b/docs/T2 Macs (2018-2020)/t2-mac.md → docs/t2-mac.md
diff --git a/docs/Documentation/tips.md → docs/tips.md b/docs/Documentation/tips.md → docs/tips.md
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -1,5 +1,5 @@
 import { themes as prismThemes } from "prism-react-renderer";
-import type { Config } from "@docusaurus/types";
+import type { Config, SidebarItem } from "@docusaurus/types";
 import type * as Preset from "@docusaurus/preset-classic";
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
@@ -32,9 +32,8 @@ const config: Config = {
           sidebarPath: "./sidebars.ts",
           // Disables the landing page
           routeBasePath: "/",
-          // FIXME: Change this into the proper URL
           editUrl:
-            "https://github.com/ublue-os/bluefin-docs/tree/main/packages/create-docusaurus/templates/shared/",
+            "https://github.com/ublue-os/bluefin-docs/tree/main/packages/docs",
         },
         theme: {
           customCss: "./src/css/custom.css",
@@ -71,7 +70,7 @@ const config: Config = {
       items: [
         {
           type: "docSidebar",
-          sidebarId: "tutorialSidebar",
+          sidebarId: "baseSidebar",
           position: "left",
           label: "Documentation",
         },

diff --git a/sidebars.ts b/sidebars.ts
@@ -13,21 +13,52 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
  Create as many sidebars as you want.
  */
 const sidebars: SidebarsConfig = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{ type: "autogenerated", dirName: "." }],
-
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
+  baseSidebar: [
+    {
+      type: 'category',
+      label: 'Documentation',
+      items: [
+        'introduction',
+        'administration',
+        'ai',
+        'bluefin-dx',
+        'tips',
+        'FAQ',
+        'press-kit'
+      ]
+    },
+    {
+      type: 'category',
+      label: 'Contributing',
+      items: [
+        'contributing',
+        'local',
+      ]
+    },
+    {
+      type: 'category',
+      label: 'Framework Laptops',
+      items: [
+        'framework',
+        'framework-13',
+        'framework-16',
+      ]
+    },
+    {
+      type: 'category',
+      label: 'T2 Macs (2018-2020)',
+      items: [
+        't2-mac',
+      ]
+    },
     {
       type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      label: 'Supporting The Project',
+      items: [
+        'donations',
+      ]
     },
   ],
-   */
 };
 
 export default sidebars;