Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: sorted sidebar + moving everything to fit flat structure #52

Merged
merged 2 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
181 changes: 0 additions & 181 deletions docs/Documentation/introduction.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/Documentation/FAQ.md → docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/Contributing/contributing.md → docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: Contributor's guide
slug: /contributing
---

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/T2 Macs (2018-2020)/t2-mac.md → docs/t2-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ author: Chris Lauretano
slug: /t2-mac
---

This is an addendum to the [Bluefin installation runbook](/Documentation/introduction.md) for T2 Macs, supporting the project's goal of sustainability by enabling Bluefin installation on the final generation of Intel Macs (2018-2020). Apple ends support for them after 2024.
This is an addendum to the [Bluefin installation runbook](/introduction.md) for T2 Macs, supporting the project's goal of sustainability by enabling Bluefin installation on the final generation of Intel Macs (2018-2020). Apple ends support for them after 2024.

Please read the original [Bluefin installation runbook](/Documentation/introduction.md) as the contents of it are not reproduced here. Section Headings match up where possible.
Please read the original [Bluefin installation runbook](/introduction.md) as the contents of it are not reproduced here. Section Headings match up where possible.

## Day 0 - Planning

Expand Down
File renamed without changes.
7 changes: 3 additions & 4 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -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...)
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -71,7 +70,7 @@ const config: Config = {
items: [
{
type: "docSidebar",
sidebarId: "tutorialSidebar",
sidebarId: "baseSidebar",
position: "left",
label: "Documentation",
},
Expand Down
53 changes: 42 additions & 11 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Loading