Merge branch 'refs/heads/main' into feat/seperate-navbars

.devcontainer/devcontainer.json

@@ -15,11 +15,11 @@
   },
   "extensions": ["esbenp.prettier-vscode"],
   "forwardPorts": [3000],
-  "postCreateCommand": ["yarn", "install"],
+  "postCreateCommand": ["pnpm", "install"],
   "waitFor": "postCreateCommand",
   "features": {
     "node": {
-      "version": "18"
+      "version": "20"
     }
   }
 }

.github/workflows/format.yml

@@ -13,16 +13,14 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: "yarn"
+          cache: "pnpm"
       - name: Install dependencies
-        uses: borales/actions-yarn@v5
-        with:
-          cmd: install
+        run: pnpm install
       - name: Check format
-        uses: borales/actions-yarn@v5
-        with:
-          cmd: format:check
+        run: pnpm run format:check

.gitignore

@@ -6,13 +6,5 @@
 .cache-loader
 .DS_Store
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 .pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
 /.meta

.prettierignore

@@ -1,4 +1,4 @@
-.yarn
+pnpm-lock.yaml
 docs/versioned
 *.md
 *.mdx

.typos.toml

@@ -18,18 +18,25 @@ armour = "armor"
 authorise = "authorize"
 authorised = "authorized"
 authorising = "authorizing"
+behaviour = "behavior"
+capitalise = "capitalize"
 catalogue = "catalog"
 centre = "center"
 civilisation = "civilization"
 civilised = "civilized"
 colour = "color"
 colours = "colors"
 defence = "defense"
+generalise = "generalize"
+generalised = "generalized"
 gramme = "gram"
 grammes = "grams"
 grey = "gray"
 honour = "honor"
 honours = "honors"
+initialise = "initialize"
+initialised = "initialized"
+initialiser = "initializer"
 kerb = "curb"
 kerbs = "curbs"
 labour = "labor"

CONTRIBUTING.md

@@ -79,6 +79,8 @@ To maintain consistency and readability across the documentation, please adhere
 2. **Markdown Format**: Documentation should be written in Markdown format (.md or .mdx) for easy rendering on the website.
 
 3. **Heading Structure**: Use `h1` (#) for the main title, `h2` (##) for section headings, and follow this pattern for subsequent subheadings.
+   Capitalize the first letter of each word in a h1, however, only capitalize the first letter of the first word in h2 and h3 unless~
+   it is a proper noun.
 
 4. **Code Blocks**: When including code snippets or terminal commands, use fenced code blocks with the appropriate syntax highlighting.
 
@@ -89,12 +91,14 @@ To maintain consistency and readability across the documentation, please adhere
 
 7. **Images**: Include images if necessary to illustrate concepts. Ensure the images are clear and relevant to the content.
 
-8. **Format Code**: After you've made changes, don't forget to run the formatting script with `yarn format`.
+8. **Format Code**: After you've made changes, don't forget to run the formatting script with `pnpm run format`.
 
 9. **Keep It Concise**: Write clear and concise sentences. Avoid unnecessary jargon and explanations.
 
 10. **Be Inclusive**: Be mindful of all readers and contributors. Use language that is inclusive and welcoming to everyone.
 
+11. **Capitalize Vanilla**: When referring to the base game, use "Vanilla" with a capital "V".
+
 ## Automatic Doc Versioning
 
 There are components and methods in order to embed the current Project Version into the documentation. This is done one
@@ -105,20 +109,20 @@ of a few ways:
    This component is used to embed the current version of the software into the documentation. An example of this would be:
 
    ```jsx
-   <SoftwareVersion versionType={"maj-min"}/> // E.g 1.19.2
-   <SoftwareVersion versionType={"maj"}/> // E.g 1.19
-   <SoftwareVersion versionType={"max"}/> // E.g 1.20.4
+   <SoftwareVersion versionType={"maj-min-pat"}/> // e.g. 1.19.2
+   <SoftwareVersion versionType={"maj-min"}/> // e.g. 1.19
+   <SoftwareVersion versionType={"maj"}/> // e.g. 1
 
-   // You can set the project name to be used for the versioning:
-   <SoftwareVersion versionType={"maj-min"} project={"velocity"}/> // Project defaults to Paper
+   // You can set the project name to be used for the versioning (defaults to paper):
+   <SoftwareVersion versionType={"maj-min-pat"} project={"velocity"}/> // e.g. 3.3.0-SNAPSHOT
    ```
 
-2. `VersionedJavaDocLink` component
+2. `Javadoc` component
 
-   This component is used to embed a link to the current version of the JavaDocs. An example of this would be:
+   This component is used to embed a link to the current version of the corresponding Javadoc. An example of this would be:
 
    ```jsx
-   <VersionedJavaDocLink target={"/org/bukkit/event/Event.html"}>here</VersionedJavaDocLink>
+   <Javadoc name={"org.bukkit.event.Event"}>here</Javadoc>
    // The project can also be set here, and defaults to Paper
    ```
 
@@ -133,24 +137,24 @@ of a few ways:
    version: '1.0'
    main: io.papermc.testplugin.TestPlugin
    description: Paper Test Plugin
-   api-version: '%%_MAJ_MC_%%'
+   api-version: '%%_MAJ_MIN_PAT_MC_%%'
    bootstrapper: io.papermc.testplugin.TestPluginBootstrap
    loader: io.papermc.testplugin.TestPluginLoader
    ```⠀
    </VersionFormattedCode>
 
    // The possible placeholders are:
-   %%_MAJ_MC_%%  - Major Paper Version (E.g. 1.20)
-   %%_MAJ_MIN_MC_%% - Major-Minor Paper Version (E.g. 1.20.4)
-   %%_MAJ_VEL_%% - Major Velocity Version (E.g. 3.3)
-   %%_MAJ_MIN_VEL_%% - Major-Minor Velocity Version (E.g. 3.3.0)
+   %%_MAJ_MIN_MC_%%  - Major-Minor Paper Version (E.g. 1.20)
+   %%_MAJ_MIN_PAT_MC_%% - Major-Minor-Patch Paper Version (E.g. 1.20.4)
+   %%_MAJ_MIN_VEL_%% - Major Velocity Version (E.g. 3.1.0)
+   %%_MAJ_MIN_PAT_VEL_%% - Major-Minor-Patch Velocity Version (E.g. 3.1.1-SNAPSHOT)
    ````
 
 When the major version of the software changes, the docs will still need to have a "snapshot" created to keep documentation
-for older versions. This is done by using yarn's docusaurus version command:
+for older versions. This is done by using Docusaurus's `version` command:
 
 ```bash
-yarn docusaurus docs:version:paper "1.20"
+pnpm docusaurus docs:version:paper "1.20"
 ```
 
 ## Magic Value Handling
@@ -161,7 +165,7 @@ multiple places, and if they change, it is important to change them in all place
 our `Property` component to embed these values into the documentation. An example of this would be:
 
 ```jsx
-<Property name="PAPER_JAVA_RECOMMENDED" />
+<Property name="PAPER_JAVA_MIN" />
 ```
 
 This will embed the value of the property into the documentation, and if it changes, it will be changed in all places.

README.md

@@ -12,7 +12,7 @@ How to get docs running on your local machine for development.
 ### Prerequisites
 
 - [node](https://nodejs.org)
-- [yarn](https://yarnpkg.com/getting-started/install)
+- [pnpm](https://pnpm.io/installation)
 
 ### Local Development
 
@@ -25,13 +25,13 @@ $ git clone https://github.com/PaperMC/docs
 2. Install all required dependencies.
 
 ```bash
-$ yarn
+$ pnpm install
 ```
 
-3. Start the development server
+3. Start the development server.
 
 ```bash
-$ yarn dev
+$ pnpm run dev
 ```
 
 This will start a local development server and open a browser window. The majority of changes will
@@ -41,7 +41,7 @@ your browser. Edit away!
 ### Building
 
 ```bash
-$ yarn build
+$ pnpm run build
 ```
 
 This command builds a production-ready deployment into the `build` directory. These files are ready

config-specs/paper/bukkit.yml

@@ -51,7 +51,7 @@ settings:
     default: update
     description: >-
       Path to replace new plugin versions with.
-      [See Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
+      See [Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
   use-map-color-cache:
     default: "true"
     description: >-
@@ -65,37 +65,37 @@ spawn-limits:
     default: "15"
     description: >-
       Set the spawn-limits for ambient mobs. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
   animals:
     default: "10"
     description: >-
       Set the spawn-limits for animals. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
   axolotls:
     default: "5"
     description: >-
       Set the spawn-limits for axolotls. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
   monsters:
     default: "70"
     description: >-
       Set the spawn-limits for monsters. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
   water-ambient:
     default: "20"
     description: >-
       Set the spawn-limits for water ambient mobs. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
   water-animals:
     default: "5"
     description: >-
       Set the spawn-limits for water animals. This can be overridden by the
-      [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
   water-underground-creature:
     default: "5"
     description: >-
       Set the spawn-limits for water underground creatures. This can be
-      overridden by the [paper-world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
+      overridden by the [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
 ticks-per:
   ambient-spawns:
     default: "1"
@@ -142,14 +142,14 @@ worlds:
     biome-provider:
       default: "N/A"
       description: >-
-        The biome provider to use for this world. Plugins must register a BiomeProvider
+        The biome provider to use for this world. Plugins must register a `BiomeProvider`
         to be used here. The format is *plugin-name:extra-parameters* or *plugin-name*
         if no extra parameters are needed. The plugin name is as defined in the
-        plugin.yml or paper-plugin.yml.
+        `plugin.yml` or `paper-plugin.yml`.
     generator:
       default: "N/A"
       description: >-
-        The generator to use for this world. Plugins must register a ChunkGenerator
+        The generator to use for this world. Plugins must register a `ChunkGenerator`
         to be used here. The format is *plugin-name:extra-parameters* or
         *plugin-name* if no extra parameters are needed. The plugin name is as defined
-        in the plugin.yml or paper-plugin.yml.
+        in the `plugin.yml` or `paper-plugin.yml`.

config-specs/paper/commands.yml

@@ -1,16 +1,16 @@
 command-block-overrides:
   default: "[<command to override>]"
   description: >
-    Which vanilla commands should be prioritized over those provided by Bukkit
-    or plugins. Useful for compatibility with adventure maps built for vanilla
+    Which Vanilla commands should be prioritized over those provided by Bukkit
+    or plugins. Useful for compatibility with adventure maps built for Vanilla
     command blocks.
 
-    Use the literal ''*'' to always use the vanilla version in command blocks.
+    Use the literal ''*'' to always use the Vanilla version in command blocks.
 
     By default, no commands are overridden.
 ignore-vanilla-permissions:
   default: "false"
-  description: Whether to use vanilla permission levels when executing commands.
+  description: Whether to use Vanilla permission levels when executing commands.
 aliases:
   <alias name>:
     default: "[<commands to run>]"

config-specs/paper/paper-global.yml

@@ -81,7 +81,7 @@ collisions:
     default: "true"
     description: >-
       Collisions with boats and minecarts are often subject to client/server
-      disagreement, which may cause glitchy behaviour for players. This setting
+      disagreement, which may cause glitchy behavior for players. This setting
       attempts to mitigate this desync by sending precise locations for entities
       involved in collisions. Having this enabled will use more bandwidth;
       however, in the majority of cases, this is a worthy tradeoff
@@ -225,7 +225,7 @@ misc:
     default: "false"
     description: >-
       Whether phantoms, wandering traders, etc. should be able to spawn in
-      custom overworlds. Defaults to false in order to match vanilla behavior
+      custom overworlds. Defaults to false in order to match Vanilla behavior
   strict-advancement-dimension-check:
     default: "false"
     description: >-
@@ -305,7 +305,7 @@ proxies:
       default: "false"
       description: Whether the server should accept Velocity Modern Forwarding
     online-mode:
-      default: "false"
+      default: "true"
       description: >-
         Instructs the server how to handle player UUIDs and data when behind
         Velocity. Always set to match your proxy's online-mode setting
@@ -317,7 +317,7 @@ proxies:
         forwarding.secret file
 scoreboards:
   save-empty-scoreboard-teams:
-    default: "false"
+    default: "true"
     description: >-
       Some scoreboard plugins leave hundreds of empty scoreboard teams around,
       dramatically slowing down login times. This sets whether the server should
@@ -400,7 +400,7 @@ unsupported-settings:
   allow-permanent-block-break-exploits:
     default: "false"
     description: >-
-      Whether unbreakable blocks can be broken with vanilla exploits. This
+      Whether unbreakable blocks can be broken with Vanilla exploits. This
       includes bedrock, end portal frames, end portal blocks, and more
   allow-piston-duplication:
     default: "false"