diff --git a/docs/Documentation/FAQ.md b/docs/FAQ.md similarity index 98% rename from docs/Documentation/FAQ.md rename to docs/FAQ.md index 20c2b09..06156cd 100644 --- a/docs/Documentation/FAQ.md +++ b/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 b/docs/administration.md similarity index 100% rename from docs/Documentation/administration.md rename to docs/administration.md diff --git a/docs/Documentation/ai.md b/docs/ai.md similarity index 100% rename from docs/Documentation/ai.md rename to docs/ai.md diff --git a/docs/Documentation/bluefin-dx.md b/docs/bluefin-dx.md similarity index 100% rename from docs/Documentation/bluefin-dx.md rename to docs/bluefin-dx.md diff --git a/docs/Contributing/contributing.md b/docs/contributing.md similarity index 99% rename from docs/Contributing/contributing.md rename to docs/contributing.md index fc62cda..374c11d 100644 --- a/docs/Contributing/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,5 @@ --- +title: Contributor's guide slug: /contributing --- diff --git a/docs/Supporting The Project/donations.md b/docs/donations.md similarity index 100% rename from docs/Supporting The Project/donations.md rename to docs/donations.md diff --git a/docs/Framework Laptops/framework-13.md b/docs/framework-13.md similarity index 100% rename from docs/Framework Laptops/framework-13.md rename to docs/framework-13.md diff --git a/docs/Framework Laptops/framework-16.md b/docs/framework-16.md similarity index 100% rename from docs/Framework Laptops/framework-16.md rename to docs/framework-16.md diff --git a/docs/Framework Laptops/framework.md b/docs/framework.md similarity index 100% rename from docs/Framework Laptops/framework.md rename to docs/framework.md diff --git a/docs/introduction.md b/docs/introduction.md index 016280c..c8dfa63 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -139,7 +139,7 @@ Bluefin strives to make maintenance as easy as possible, however many of the aut - `ujust changelogs` will show incoming changes and updates coming from Fedora - `ujust bios` will reboot the machine and enter the BIOS/UEFI menu. This is useful for booting into a Windows drive - Subscribe to the [announcements tag](https://universal-blue.discourse.group/tag/announcements) on the Universal Blue forums -- Understand [rebase and rollback procedures](/Documentation/administration.md#switching-between-streams) +- Understand [rebase and rollback procedures](/administration.md#switching-between-streams) - Use the [Warehouse application](https://github.com/flattool/warehouse) to manage Flatpak lifecycle: - Pin to an old version or rollback - Easily remove applications at once diff --git a/docs/Contributing/local.md b/docs/local.md similarity index 100% rename from docs/Contributing/local.md rename to docs/local.md diff --git a/docs/Documentation/press-kit.md b/docs/press-kit.md similarity index 100% rename from docs/Documentation/press-kit.md rename to docs/press-kit.md diff --git a/docs/T2 Macs (2018-2020)/t2-mac.md b/docs/t2-mac.md similarity index 100% rename from docs/T2 Macs (2018-2020)/t2-mac.md rename to docs/t2-mac.md diff --git a/docs/Documentation/tips.md b/docs/tips.md similarity index 100% rename from docs/Documentation/tips.md rename to docs/tips.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ba24a59..40a0540 100644 --- 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 index 574ed39..fe9872d 100644 --- 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;