diff --git a/config/navbar.config.ts b/config/navbar.config.ts index 3a48cc505..e3a48d39a 100644 --- a/config/navbar.config.ts +++ b/config/navbar.config.ts @@ -9,14 +9,38 @@ const navbar: Omit = { }, items: [ { - to: "paper", + type: "dropdown", label: "Paper", position: "left", + items: [ + { + type: "doc", + label: "Server Administrator", + docId: "paper/README", + }, + { + type: "doc", + label: "Developer", + docId: "dev/paper/README", + }, + ], }, { - to: "velocity", + type: "dropdown", label: "Velocity", position: "left", + items: [ + { + type: "doc", + label: "Server Administrator", + docId: "velocity/README", + }, + { + type: "doc", + label: "Developer", + docId: "dev/velocity/README", + }, + ], }, { to: "waterfall", diff --git a/config/sidebars.config.ts b/config/sidebars.config.ts index 03d48dc45..724805174 100644 --- a/config/sidebars.config.ts +++ b/config/sidebars.config.ts @@ -1,24 +1,7 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; const sidebars: SidebarsConfig = { - docs: [ - { - type: "category", - label: "Getting Help", - items: [ - { - type: "link", - label: "Discord", - href: "https://discord.gg/papermc", - }, - { - type: "link", - label: "Forums", - href: "https://forums.papermc.io", - }, - ], - }, - "README", + admin: [ { type: "category", label: "Paper", @@ -45,7 +28,7 @@ const sidebars: SidebarsConfig = { label: "How-to Guides", link: { type: "generated-index", - slug: "/category/paper/how-to-guides", + slug: "category//paper/how-to-guides", }, items: [ "paper/how-to/per-world-configuration", @@ -59,7 +42,7 @@ const sidebars: SidebarsConfig = { label: "Reference", link: { type: "generated-index", - slug: "/category/paper/reference", + slug: "category//paper/reference", }, items: [ "paper/reference/paper-global-configuration", @@ -95,7 +78,7 @@ const sidebars: SidebarsConfig = { label: "How-to Guides", link: { type: "generated-index", - slug: "/category/velocity/how-to-guides", + slug: "category//velocity/how-to-guides", }, items: [ "velocity/how-to/security", @@ -108,7 +91,7 @@ const sidebars: SidebarsConfig = { label: "Reference", link: { type: "generated-index", - slug: "/category/velocity/reference", + slug: "category//velocity/reference", }, items: [ "velocity/reference/configuration", @@ -118,55 +101,6 @@ const sidebars: SidebarsConfig = { "velocity/reference/libraries", ], }, - { - type: "category", - label: "Developers", - link: { - type: "doc", - id: "velocity/developers/README", - }, - items: [ - { type: "ref", id: "velocity/developers/README" }, - { - type: "category", - label: "Getting Started", - link: { - type: "generated-index", - slug: "/category/velocity/developers/getting-started", - }, - items: [ - "velocity/developers/getting-started/creating-your-first-plugin", - "velocity/developers/getting-started/api-basics", - "velocity/developers/getting-started/pitfalls", - ], - }, - { - type: "category", - label: "How-to Guides", - link: { - type: "generated-index", - slug: "/category/velocity/developers/how-to-guides", - }, - items: [ - "velocity/developers/how-to/dependencies", - "velocity/developers/how-to/porting-from-velocity-1", - ], - }, - { - type: "category", - label: "API", - link: { - type: "generated-index", - slug: "/category/velocity/developers/api", - }, - items: [ - "velocity/developers/api/event", - "velocity/developers/api/command", - "velocity/developers/api/scheduler", - ], - }, - ], - }, ], }, { @@ -183,20 +117,78 @@ const sidebars: SidebarsConfig = { label: "Common", link: { type: "generated-index", - slug: "/category/common", + slug: "category/common", description: "Documentation relevant to all PaperMC projects.", }, - items: ["common/java-install"], + items: ["common/java-install", "common/downloads-api", "common/assets", "common/contact"], }, + ], + dev: [ { type: "category", - label: "PaperMC", + label: "Paper", link: { - type: "generated-index", - slug: "/category/papermc", - description: "Information about the PaperMC Organization.", + type: "doc", + id: "dev/paper/README", + }, + items: [ + { + type: "ref", + id: "dev/paper/README", + }, + ], + }, + { + type: "category", + label: "Velocity", + link: { + type: "doc", + id: "dev/velocity/README", }, - items: ["papermc/downloads-api", "papermc/assets", "papermc/contact"], + items: [ + { + type: "ref", + id: "dev/velocity/README", + }, + { + type: "category", + label: "Getting Started", + link: { + type: "generated-index", + slug: "category/dev/velocity/getting-started", + }, + items: [ + "dev/velocity/getting-started/creating-your-first-plugin", + "dev/velocity/getting-started/api-basics", + "dev/velocity/getting-started/pitfalls", + ], + }, + { + type: "category", + label: "How-to Guides", + link: { + type: "generated-index", + slug: "category/dev/velocity/how-to-guides", + }, + items: [ + "dev/velocity/how-to/dependencies", + "dev/velocity/how-to/porting-from-velocity-1", + ], + }, + { + type: "category", + label: "API", + link: { + type: "generated-index", + slug: "category/dev/velocity/api", + }, + items: [ + "dev/velocity/api/event", + "dev/velocity/api/command", + "dev/velocity/api/scheduler", + ], + }, + ], }, ], }; diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 40819e288..000000000 --- a/docs/README.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -slug: /intro ---- - -# Introduction - -Welcome to the official source of documentation for the [PaperMC](https://github.com/PaperMC) -project. - -:::tip - -Contributing Most of the documentation here was created by our community, for our community. It's -easier than you may think! See our [contributing guide] for more information. - -::: - -## Getting Help - -If you're ever confused or need help, do not hesitate to join our -[Discord](https://discord.gg/papermc) for support. Please only ask for help in the relevant `#-help` -channel for using the project, and the `#-dev` channel for development of the project or using the -project's API. diff --git a/docs/papermc/assets.md b/docs/common/assets.md similarity index 100% rename from docs/papermc/assets.md rename to docs/common/assets.md diff --git a/docs/papermc/contact.md b/docs/common/contact.md similarity index 100% rename from docs/papermc/contact.md rename to docs/common/contact.md diff --git a/docs/papermc/downloads-api.md b/docs/common/downloads-api.md similarity index 100% rename from docs/papermc/downloads-api.md rename to docs/common/downloads-api.md diff --git a/docs/papermc/papermc_logomark_500.png b/docs/common/papermc_logomark_500.png similarity index 100% rename from docs/papermc/papermc_logomark_500.png rename to docs/common/papermc_logomark_500.png diff --git a/docs/dev/paper/README.md b/docs/dev/paper/README.md new file mode 100644 index 000000000..6bb9beed5 --- /dev/null +++ b/docs/dev/paper/README.md @@ -0,0 +1,3 @@ +# Paper Developers Guide + +Welcome to the Paper developer guide! TODO diff --git a/docs/velocity/developers/README.md b/docs/dev/velocity/README.md similarity index 100% rename from docs/velocity/developers/README.md rename to docs/dev/velocity/README.md diff --git a/docs/velocity/developers/api/command.md b/docs/dev/velocity/api/command.md similarity index 99% rename from docs/velocity/developers/api/command.md rename to docs/dev/velocity/api/command.md index f36042bdb..22a2cef94 100644 --- a/docs/velocity/developers/api/command.md +++ b/docs/dev/velocity/api/command.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/command-api +slug: /dev/velocity/command-api --- # The Command API diff --git a/docs/velocity/developers/api/event.md b/docs/dev/velocity/api/event.md similarity index 99% rename from docs/velocity/developers/api/event.md rename to docs/dev/velocity/api/event.md index a8948a6fb..195854d88 100644 --- a/docs/velocity/developers/api/event.md +++ b/docs/dev/velocity/api/event.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/event-api +slug: /dev/velocity/event-api --- # Working With Events diff --git a/docs/velocity/developers/api/scheduler.md b/docs/dev/velocity/api/scheduler.md similarity index 98% rename from docs/velocity/developers/api/scheduler.md rename to docs/dev/velocity/api/scheduler.md index 54c86f5dc..50c2426aa 100644 --- a/docs/velocity/developers/api/scheduler.md +++ b/docs/dev/velocity/api/scheduler.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/scheduler-api +slug: /dev/velocity/scheduler-api --- # Using the Scheduler diff --git a/docs/velocity/developers/getting-started/api-basics.md b/docs/dev/velocity/getting-started/api-basics.md similarity index 99% rename from docs/velocity/developers/getting-started/api-basics.md rename to docs/dev/velocity/getting-started/api-basics.md index 510a0937a..a6419497f 100644 --- a/docs/velocity/developers/getting-started/api-basics.md +++ b/docs/dev/velocity/getting-started/api-basics.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/api-basics +slug: /dev/velocity/api-basics --- # Velocity Plugin Basics diff --git a/docs/velocity/developers/getting-started/creating-your-first-plugin.md b/docs/dev/velocity/getting-started/creating-your-first-plugin.md similarity index 98% rename from docs/velocity/developers/getting-started/creating-your-first-plugin.md rename to docs/dev/velocity/getting-started/creating-your-first-plugin.md index 969aed336..611c65c0a 100644 --- a/docs/velocity/developers/getting-started/creating-your-first-plugin.md +++ b/docs/dev/velocity/getting-started/creating-your-first-plugin.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/creating-your-first-plugin +slug: /dev/velocity/creating-your-first-plugin --- # Creating Your First Plugin diff --git a/docs/velocity/developers/getting-started/pitfalls.md b/docs/dev/velocity/getting-started/pitfalls.md similarity index 97% rename from docs/velocity/developers/getting-started/pitfalls.md rename to docs/dev/velocity/getting-started/pitfalls.md index 3e65e82c8..5be44dcbd 100644 --- a/docs/velocity/developers/getting-started/pitfalls.md +++ b/docs/dev/velocity/getting-started/pitfalls.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/pitfalls +slug: /dev/velocity/pitfalls --- # Common Pitfalls diff --git a/docs/velocity/developers/how-to/dependencies.md b/docs/dev/velocity/how-to/dependencies.md similarity index 97% rename from docs/velocity/developers/how-to/dependencies.md rename to docs/dev/velocity/how-to/dependencies.md index 2726858b1..9286a0081 100644 --- a/docs/velocity/developers/how-to/dependencies.md +++ b/docs/dev/velocity/how-to/dependencies.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/dependency-management +slug: /dev/velocity/dependency-management --- # Dependency Management diff --git a/docs/velocity/developers/how-to/porting-from-velocity-1.md b/docs/dev/velocity/how-to/porting-from-velocity-1.md similarity index 96% rename from docs/velocity/developers/how-to/porting-from-velocity-1.md rename to docs/dev/velocity/how-to/porting-from-velocity-1.md index 5752e7227..93d2cfa01 100644 --- a/docs/velocity/developers/how-to/porting-from-velocity-1.md +++ b/docs/dev/velocity/how-to/porting-from-velocity-1.md @@ -1,5 +1,5 @@ --- -slug: /velocity/developers/porting-plugins-from-velocity-1 +slug: /dev/velocity/porting-plugins-from-velocity-1 --- # Porting Your Plugin from Velocity 1.x.x diff --git a/docs/paper/reference/paper-global-configuration.md b/docs/paper/reference/paper-global-configuration.md index 74fc642ce..b2db157bf 100644 --- a/docs/paper/reference/paper-global-configuration.md +++ b/docs/paper/reference/paper-global-configuration.md @@ -1,5 +1,4 @@ --- -slug: /paper/reference/paper-global-configuration keywords: - paper.yml - paper.yml settings diff --git a/docs/paper/reference/paper-per-world-configuration.md b/docs/paper/reference/paper-per-world-configuration.md index 138afb346..ed05476be 100644 --- a/docs/paper/reference/paper-per-world-configuration.md +++ b/docs/paper/reference/paper-per-world-configuration.md @@ -1,5 +1,4 @@ --- -slug: /paper/reference/paper-per-world-configuration keywords: - paper.yml - paper.yml world-settings diff --git a/src/components/Projects.tsx b/src/components/Projects.tsx index db27a57bf..89b118d53 100644 --- a/src/components/Projects.tsx +++ b/src/components/Projects.tsx @@ -1,6 +1,7 @@ import Link from "@docusaurus/Link"; import React from "react"; import styles from "../css/projects.module.css"; +import clsx from "clsx"; const projects: Project[] = [ { @@ -8,19 +9,21 @@ const projects: Project[] = [ description: "High performance Minecraft server that aims to fix gameplay and mechanics inconsistencies.", repo: "PaperMC/Paper", - link: "/paper", + admin: "/paper", + developer: "/dev/paper", }, { title: "Velocity", description: "The modern, next-generation Minecraft server proxy.", repo: "PaperMC/Velocity", - link: "/velocity", + admin: "/velocity", + developer: "/dev/velocity", }, { title: "Waterfall", description: "BungeeCord proxy fork that aims to improve performance and stability.", repo: "PaperMC/Waterfall", - link: "/waterfall", + admin: "/waterfall", }, ]; @@ -33,10 +36,20 @@ function Project(project: Project) {

{project.description}

-
- - Go - +
+ {project.admin ? ( + + Server Admin + + ) : null} + {project.developer ? ( + + Developer + + ) : null}
); @@ -58,5 +71,6 @@ interface Project { title: string; description: string; repo: string; - link: string; + admin?: string; + developer?: string; } diff --git a/src/css/projects.module.css b/src/css/projects.module.css index d150b0552..a4d91dd17 100644 --- a/src/css/projects.module.css +++ b/src/css/projects.module.css @@ -1,3 +1,7 @@ +:root { + --ifm-button-padding-horizontal: 1rem; +} + .flex { flex-grow: 1; } @@ -36,3 +40,8 @@ padding-bottom: 8em; padding-top: 0; } + +.links { + display: flex; + flex-direction: column; +}