General fixes and reformatting to match template + general tweaks - #430
Open
JustAMatt wants to merge 28 commits into
Open
General fixes and reformatting to match template + general tweaks#430JustAMatt wants to merge 28 commits into
JustAMatt wants to merge 28 commits into
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
7 issues found across 117 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/using_the_panel/sftp.md">
<violation number="1" location="docs/using_the_panel/sftp.md:30">
P3: This revised guidance contains a comma splice between the recommendation and its rationale. Splitting it into two sentences improves readability.</violation>
<violation number="2" location="docs/using_the_panel/sftp.md:86">
P3: Screen-reader users are told this is a WinSCP form even though the screenshot illustrates the MobaXTerm setup step. The alt text should identify MobaXTerm instead.</violation>
</file>
<file name="docs/not-found.mdx">
<violation number="1" location="docs/not-found.mdx:3">
P3: This edit leaves `docs/not-found.mdx` split evenly between LF and CRLF line endings, making future formatting diffs noisy; normalizing the whole file to one line-ending style would keep the cleanup consistent.</violation>
</file>
<file name="docs/using_the_panel/schedules.mdx">
<violation number="1" location="docs/using_the_panel/schedules.mdx:20">
P3: The opening definition reads awkwardly because the `such as` example lacks a separating comma and uses a slash-heavy action list. A direct “Schedules let you…” construction would make this clearer and more concise.</violation>
</file>
<file name="docs/running_a_server/spark.md">
<violation number="1" location="docs/running_a_server/spark.md:5">
P3: The newly visible table of contents exposes `What does the plugin do?` and `Setup` as level-3 sections before any level-2 parent, producing misleading navigation hierarchy. Consider promoting those two headings to `##` (or keeping the TOC hidden until the hierarchy is corrected).</violation>
</file>
<file name="docs/running_a_server/worlds.md">
<violation number="1" location="docs/running_a_server/worlds.md:22">
P3: The visible table of contents loses the relationship between “Importing Worlds” and its three import methods because all four headings are now level 2. Keeping this parent at level 2 and changing each “From …” subsection to level 3 would restore the intended hierarchy.</violation>
</file>
<file name="docs/VPS/virtfusion-rescue.md">
<violation number="1" location="docs/VPS/virtfusion-rescue.md:4">
P3: The newly visible TOC groups the entire rescue procedure under “Prerequisites,” making navigation misleading. Consider promoting the three procedural headings to H2 sections, consistent with the contributor template’s top-level section guidance.</violation>
</file>
Tip: instead of fixing issues one by one fix them all with cubic
Re-trigger cubic
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Contributor
Author
|
P3: The Timings page now has two identical How to take a Timings Report H2 headings: the new introductory heading and the existing procedure heading below. Renaming the introductory section to describe the warning/status (or removing it) would keep the page hierarchy and generated anchors unambiguous. P3: Additional Information is now an empty section because Friendly URLs and Links remain sibling H2 headings. Consider making those subsections H3, or removing the empty wrapper heading. Will resolve that with a commit rq |
Contributor
Author
|
Should be ready for review now @ClumsyAdmin |
Contributor
Author
|
I hid the footer once again. I think the bloom logo above each doc might be broken on this build, but it works locally. How can we retrigger that Cloudflare deployment? lol |
Contributor
Author
|
Cubic broke the logo lmao reverted |
Member
|
I still see cubic comments that are still applicable, and regarding the logo the AI assumed that logo.svg/logo.webp are the same image but they aren't. I would download this svg https://bloom.host/img/logomark.svg and use that for it instead |
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Contributor
|
I've fixed all 9 issues from the PR review:
diff --git a/docs/VPS/virtfusion-rescue.md b/docs/VPS/virtfusion-rescue.md
index f02926e..ff9ee8a 100644
--- a/docs/VPS/virtfusion-rescue.md
+++ b/docs/VPS/virtfusion-rescue.md
@@ -24,7 +24,7 @@ In this guide we'll learn how to access our VPS via our Bloom.host VirtFusion pa
Before following this guide, make sure you've enabled VNC and opened the Console. To do so, follow our [VirtFusion VNC Guide](/VPS/virtfusion-vnc).
-### Starting Rescue Mode
+## Starting Rescue Mode
:::note Rescue Mode Use Cases
Rescue Mode boots a minimal operating system independent of the server's main disk. It's designed to help you troubleshoot and fix issues such as boot failures, misconfigurations, or corrupted filesystems. Once your issue is resolved, you can disable rescue mode and the server will return to its standard operating environment.
@@ -34,9 +34,9 @@ First, we'll head over to our panel and access the specific VPS we want to manag
-Once we've selected our server, we'll want to head over to the "Options" tab as shown above. We'll pick the second option of all the subtabs available, as shown in the screenshot. Here we can click "Create Rescue Session" to begin the process. Debian Live is the only rescue image available at the moment.
+Once we've selected our server, we'll want to head over to the "Options" tab as shown above. We'll pick the second option of all the subtabs available, as shown in the screenshot. Here we can click "Create Rescue Session" to begin the process. Debian Live is the only rescue image available at the moment.
-### Opening Console
+## Opening Console
@@ -50,9 +50,9 @@ Your credentials will be sent to you via email at the registered address. The em
As you can see, the credentials you'll receive are not so easy to type manually. VNC doesn't support pasting in content from your clipboard (keep in mind, VNC doesn't sync with anything but your raw key by key presses and mouse movements). But, as explained in the VNC guide, and as shown above, VirtFusion's VNC Console has a paste feature!
-Now you are logged in and ready to continue with your task in Rescue Mode.
+Now you are logged in and ready to continue with your task in Rescue Mode.
-### Ending Rescue Session
+## Ending Rescue Session
:::caution Security Risks
To minimize attack vectors, it's recommended that VNC be only enabled as needed. Disabling the function between uses.
diff --git a/docs/not-found.mdx b/docs/not-found.mdx
index a0dba87..7616b86 100644
--- a/docs/not-found.mdx
+++ b/docs/not-found.mdx
@@ -1,10 +1,10 @@
----
-id: not-found
+---
+id: not-found
title: Page Not Found
hide_table_of_contents: true
-description: The requested page could not be found
-displayed_sidebar: docs
-show_header: false
+description: The requested page could not be found
+displayed_sidebar: docs
+show_header: false
---
import Head from '@docusaurus/Head';
@@ -14,19 +14,19 @@ import Head from '@docusaurus/Head';
</Head>
<div id="not-found-wrapper">
- <h1>404</h1>
- <h2>Page Not Found</h2>
- <div>
- <p>
+ <h1>404</h1>
+ <h2>Page Not Found</h2>
+ <div>
+ <p>
The requested page could not be found. Return to <a href="/">Getting Started</a>, use the search
button in the top-right corner, or <a href="https://discord.gg/bloom">contact support on Discord</a>.
- </p>
- </div>
- <div>
+ </p>
+ </div>
+ <div>
<p>Here's a duck in the meantime.</p>
<img src="/extras/templatexample/duck.jpg"
- height="50%"
- width="50%"
+ height="50%"
+ width="50%"
alt="Duck standing beside a pond"/>
- </div>
-</div>
+ </div>
+</div>
diff --git a/docs/running_a_server/converting-worlds.md b/docs/running_a_server/converting-worlds.md
index 7f4fdc5..6bcfbce 100644
--- a/docs/running_a_server/converting-worlds.md
+++ b/docs/running_a_server/converting-worlds.md
@@ -22,7 +22,7 @@ If you upload or generate a world on a Bukkit/Spigot/Paper server, you will noti
---
## Part 1: Download the world
-**Note:** This is not strictly necessary, you CAN use SFTP or the File Manager if you want, but downloading the files makes them much easier to work with.
+**Note:** This is not strictly necessary; you can use SFTP or the File Manager if you want, but downloading the files makes them much easier to work with.
This is most easily done by archiving the files using the File Manager and downloading them using SFTP. For instructions on using the File Manager and SFTP, please see [File Manager Controls](/file-manager-controls/) and [How to use SFTP](/sftp/), respectively.
diff --git a/docs/running_a_server/spark.md b/docs/running_a_server/spark.md
index c8f3786..1b2fe32 100644
--- a/docs/running_a_server/spark.md
+++ b/docs/running_a_server/spark.md
@@ -16,11 +16,11 @@ keywords:
- Minecraft
---
-### What does the plugin do?
+## What does the plugin do?
Spark is a performance profiling plugin that can display server information, such as TPS, memory, tick durations, CPU usage, and disk usage. But more importantly it can create a performance profile that can be viewed on a fully feature web interface.
It does not require any configuration and is incredibly easy to install.
-### Setup
+## Setup
:::note
You can ignore this step if you are running Purpur 1.19.1 or above.
diff --git a/docs/running_a_server/worlds.md b/docs/running_a_server/worlds.md
index ac512e0..35a2842 100644
--- a/docs/running_a_server/worlds.md
+++ b/docs/running_a_server/worlds.md
@@ -1,8 +1,8 @@
---
id: worlds
-title: Managing Minecraft Worlds
+title: Managing Minecraft Worlds
slug: /worlds
-hide_table_of_contents: false
+hide_table_of_contents: false
sidebar_label: Managing Worlds
description: Learn how you can upload, export and manage your Minecraft worlds.
keywords:
@@ -19,38 +19,38 @@ keywords:
If you'd like to import ALL your files from another hosting company, please follow our [Server Importer](/server-importer) guide instead!
:::
-## Importing Worlds
+## Importing Worlds
Depending on your specific edition and world, there are a couple of methods of importing worlds.
-## From Java Edition Single Player
+### From Java Edition Single Player
If you have a single player world in Java Edition, this is what you need to do:
Open the single player menu and select your world. Then, press the 'Edit' button:
-
+
Here, press the 'Open World Folder' button:
-
+
Then, select all the files within the open directory and right click. Select 'Send To' and 'Compressed (zipped) folder':
-
+
You may get a warning about empty folders being skipped but that is okay!
-Next, follow [our guide on connecting to your server with an SFTP client](/sftp). In most cases, your world files will be fairly large, so it's best to use a dedicated file transfer protocol, instead of the built-in File Manager.
+Next, follow [our guide on connecting to your server with an SFTP client](/sftp). In most cases, your world files will be fairly large, so it's best to use a dedicated file transfer protocol, instead of the built-in File Manager.
Once connected via SFTP, right click in SFTP and create a new folder, such as `my-world` and open it.
-
+
Drag & drop the ZIP file you created previously and wait until it finishes uploading.
-
+
Once that's done, head over to the 'File Manager' tab of the panel and locate and your folder.
Within, press the '...' button next to your ZIP and click 'Unarchive'. This may also take a few minutes depending on the size of your server.
-
+
After unzipping, here is how it should generally look.
-
+
Now, if you'd like this to be your main world, open the `server.properties` file in the main directory of your server and ensure the `level-name=` setting matches with the folder that you created before:
-
+
Alternatively, if you'd like to use a plugin or mod such as [Multiverse-Core](/plugins/multiverse), you can import it using the folder's name.
In our example, for Multiverse-Core, you'd do `/mvimport my-world NORMAL`
@@ -59,65 +59,65 @@ That's it! Make sure to restart your server to apply the changes.
---
-## From Java Realms
+### From Java Realms
If you have a Minecraft Realm on Java Edition, this is what you need to do:
Open the Realm menu, select your Realm and press 'Configure':
-
+
Switch to the world you'd like to import to your Bloom server by clicking it, if you haven't already.
There press the 'World backups' button:
-
+
Lastly, press the 'Download latest' button which will download the very latest backup of your Realm to your single player saves folder:
-
+
That's it! Now you can follow the ['From Java Edition Single Player'](#from-java-edition-single-player) chapter to import your Realm world!
---
-## From Bedrock Edition Single Player
+### From Bedrock Edition Single Player
If you have a single player world in Bedrock Edition, this is what you need to do:
Open the worlds list and press the edit button next to your desired world:
-
+
Scroll down to the very bottom of the main page and press 'Export World':
-
+
Select your desktop, or another easy to access location:
-
+
-Next, follow [our guide on connecting to your server with an SFTP client](/sftp). In most cases, your world files will be fairly large, so it's best to use a dedicated file transfer protocol, instead of the built-in File Manager.
+Next, follow [our guide on connecting to your server with an SFTP client](/sftp). In most cases, your world files will be fairly large, so it's best to use a dedicated file transfer protocol, instead of the built-in File Manager.
Once connected via SFTP, open the `worlds` directory and create a new folder, such as `my-world` and open it.
-
+
Drag & drop the world file you exported previously and wait until it finishes uploading.
Once it does, rename it, so instead of ending in `.mcworld`, it ends in `.zip`. The rest of the name does not matter.
-
+
Once that's done, head over to the 'File Manager' tab of the panel and locate and your folder in the `worlds` directory.
Then, press the '...' button next to your ZIP and click 'Unarchive'. This may also take a few minutes depending on the size of your server.
-
+
After unzipping, here is how it should generally look.
-
+
Lastly, open the `server.properties` file in the main directory of your server and ensure the `level-name=` setting matches with the folder that you created before:
-
+
That's it! Make sure to restart your server to apply the changes.
---
-## Resetting Worlds
-See our full [world reset guide](/world-reset)!
+## Resetting Worlds
+See our full [world reset guide](/world-reset)!
<!--
// Todo:
---
-## Exporting Worlds
+## Exporting Worlds
## To Java Single Player
diff --git a/docs/using_the_panel/schedules.mdx b/docs/using_the_panel/schedules.mdx
index c15ce60..ee91ea3 100644
--- a/docs/using_the_panel/schedules.mdx
+++ b/docs/using_the_panel/schedules.mdx
@@ -17,7 +17,7 @@ keywords:
### What Are Schedules?
-Schedules are ways to automate certain tasks through DuckPanel such as starting/stopping/restarting the server, executing commands or even creating a backup.
+Schedules let you automate certain tasks through DuckPanel, such as starting, stopping, or restarting the server, executing commands, or creating backups.
---
:::note
diff --git a/docs/using_the_panel/server-importer.mdx b/docs/using_the_panel/server-importer.mdx
index 9e82ffe..27b7cb4 100644
--- a/docs/using_the_panel/server-importer.mdx
+++ b/docs/using_the_panel/server-importer.mdx
@@ -16,7 +16,7 @@ keywords:
### How it works
-DuckPanel has a convenient Server Importer feature. The Server Importer allows you to easily import your server into Bloom.host, saving time and avoiding having to download/upload files yourself.
+DuckPanel has a Server Importer feature that allows you to import your server into Bloom.host, saving time and avoiding having to download and upload files yourself.
:::note
You can also import the databases hosted on your old host! Follow the [database import guide](/databases#importing-mysql-databases-through-the-panel) to see how to import databases.
diff --git a/docs/using_the_panel/sftp.md b/docs/using_the_panel/sftp.md
index d6d2194..bce3d04 100644
--- a/docs/using_the_panel/sftp.md
+++ b/docs/using_the_panel/sftp.md
@@ -27,7 +27,7 @@ keywords:
**S**SH **F**ile **T**ransfer **P**rotocol is one of the most popular methods of securely transferring files to remote servers.
:::important
-We recommend you zip the files you want to upload to your server, uploading individual files through SFTP can take a long time. Once you have uploaded the .zip file to your server, you can go to the File Manager in DuckPanel, click on the three dots `...` to the right of the .zip and click on `Extract`.
+We recommend you zip the files you want to upload to your server. Uploading individual files through SFTP can take a long time. Once you have uploaded the .zip file to your server, you can go to the File Manager in DuckPanel, click on the three dots `...` to the right of the .zip and click on `Extract`.
:::
### More Actions like compress, extract, rename, and others
@@ -81,9 +81,9 @@ You can drag, drop, rename and delete files as you wish.
### Using MobaXTerm (Available only on Windows)
Firstly, you'll have to download [MobaXTerm](https://mobaxterm.mobatek.net/download.html). They offer both a free edition and a paid professional version. The installation wizard is straightforward.
-Once installed, launch the application. Right-click on the left side of the screen and click 'New Session'. Select 'SFTP' in the middle.
+Once installed, launch the application. Right-click on the left side of the screen and click 'New Session'. Select 'SFTP' in the middle.
-
+
Enter your host's IP, port, and SFTP username (which can be found in the DuckPanel server settings tab). Then click 'OK'.
You will be asked for your panel password, which will be stored by default.
Files changed:
|
Contributor
Author
|
Is there a real reason to change the image format? |
Contributor
Author
|
I fixed all other proposals made by Cubic that made sense. |
Contributor
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/using_the_panel/server-importer.mdx">
<violation number="1" location="docs/using_the_panel/server-importer.mdx:19">
P3: The destination product is now named “Bloom” instead of the standardized “Bloom.host”, making this guide inconsistent with the documented product terminology. Retaining the full brand name would keep this wording consistent.</violation>
</file>
Tip: Review your code locally with the cubic CLI to iterate faster.
Fix all with cubic | Re-trigger cubic
| ### How it works | ||
|
|
||
| Duck Panel has a convenient server importer feature. The server importer allows you to easily import your server into Bloom, saving time and avoiding having to download/upload files yourself. | ||
| DuckPanel's Server Importer lets you import your server into Bloom without downloading and uploading the files yourself. |
Contributor
There was a problem hiding this comment.
P3: The destination product is now named “Bloom” instead of the standardized “Bloom.host”, making this guide inconsistent with the documented product terminology. Retaining the full brand name would keep this wording consistent.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/using_the_panel/server-importer.mdx, line 19:
<comment>The destination product is now named “Bloom” instead of the standardized “Bloom.host”, making this guide inconsistent with the documented product terminology. Retaining the full brand name would keep this wording consistent.</comment>
<file context>
@@ -16,7 +16,7 @@ keywords:
### How it works
-DuckPanel has a convenient Server Importer feature. The Server Importer allows you to easily import your server into Bloom.host, saving time and avoiding having to download/upload files yourself.
+DuckPanel's Server Importer lets you import your server into Bloom without downloading and uploading the files yourself.
:::note
</file context>
Suggested change
| DuckPanel's Server Importer lets you import your server into Bloom without downloading and uploading the files yourself. | |
| DuckPanel's Server Importer lets you import your server into Bloom.host without downloading and uploading the files yourself. |
Contributor
Author
There was a problem hiding this comment.
I should instead make sure we use Bloom and not Bloom.host across our docs, I'll work on that Sunday
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
ClumsyAdmin
requested changes
Jul 31, 2026
ClumsyAdmin
left a comment
ClumsyAdmin
left a comment
Member
There was a problem hiding this comment.
Some minor things and still need some addressing of initial cubic review
| id: virtfusion-image | ||
| title: Mounting an Image in VirtFusion | ||
| hide_table_of_contents: true | ||
| sidebar_label: VirtFusion Images |
Member
There was a problem hiding this comment.
I would assume VirtFusion Images would mean the images we offer/have available for install, so maybe rename this to VirtFusion CD/ISO Mounting? Or something like that?
| The [official requirements](https://docs.palworldgame.com/getting-started/requirements/) specify 16 GB of memory and recommend more than 32 GB for larger servers. An 8 GB server may start, but has a higher risk of crashing due to insufficient memory. | ||
|
|
||
| As of January 19th 2024 the server requires about 5GB of storage space. This might extend with further content/updates. | ||
| Use SSD storage where possible; the official guide warns that low-performance storage may corrupt save data. |
Member
There was a problem hiding this comment.
We don't offer any servers with HDD storage so don't need to mention SSD
| --- | ||
| id: admin | ||
| title: Admin Privileges | ||
| title: Rust Admin Privileges |
Member
There was a problem hiding this comment.
We're already under the Rust section, why add Rust again?
I guess we're doing this in other sections too, not sure if it's needed
| Plan is an extremely popular & useful plugin that you can use to track server stats such as player counts, average playtime, and much more. You can find it on the [PLAN Spigot resource page](https://www.spigotmc.org/resources/plan-player-analytics.32536/). | ||
|
|
||
| #### Installation Steps: | ||
| 1. For this to work you will need your own custom domain, such as **domain.com**. Go to your DNS page and set up a new CNAME record. Set the name to “plan” (you can also use anything else like “stats”, note that you will have to use that value instead of “plan” later on as well), and set the target to `revproxy-us.bloom.host` if your server is in the US or `revproxy-eu.bloom.host` if your server is in the EU. Also, make sure proxy status is set to “DNS only” so that the little cloud icon is gray instead of orange. |
Member
There was a problem hiding this comment.
We should instead just direct to revproxy guide for the first step rather than have its own mini guide here
| --- | ||
| id: worlds | ||
| title: Managing Worlds | ||
| title: Managing Minecraft Worlds |
Member
There was a problem hiding this comment.
I guess this should be a separate issue we need to handle with the docs as a whole, whether we include or not include the title of the game if its in the corresponding section already
| ``` | ||
|
|
||
| ``` | ||
| ```html |
Member
There was a problem hiding this comment.
"No language indicated" but language is indicated?
Member
There was a problem hiding this comment.
If we're removing the reference of the list of modpacks in this document (which doesn't exist atm) we should remove it in the other places in the doc as well
Member
There was a problem hiding this comment.
This file is confusing because we replaced where we referenced this file with templateextra, and we now renamed the title of this to markdown syntax reference but didn't rename the file itself?
|
|
||
| You can also see [a formatted version of the template](https://docs.bloom.host/extras/template/) to see what the | ||
| formatted elements will look like when imported into the documentation website. | ||
| You can also see [the formatted template](https://docs.bloom.host/extras/templatexample/) to preview how the |
Member
There was a problem hiding this comment.
Should we not add any reference to template/markdown syntax example?
ClumsyAdmin
reviewed
Jul 31, 2026
| --- | ||
|
|
||
| # Converting Bukkit Worlds to vanilla | ||
| ## Converting Bukkit Worlds to vanilla |
Member
There was a problem hiding this comment.
We have Vanilla capitalized in the title, should be capitalized here
- Removed redundant Bloom.host tag entries - Changed Bloom.host to Bloom where appropriate - Changed Bloom panel to DuckPanel where appropriate - Changed Image to CD/ISO - Removed missed slop regarding SSD - We're already under the Rust section, why add Rust again? - Remade the PLAN page with full template compliance and the reverse proxy guide reference - Removed redundant example in template - Replaced modpack extras guide references for https://bloom.host/modpacks/ - Made Template and Markdown Syntax guide visible and clarified their roles - Remade "### Templates and formatting help" in readme and removed the previous recommendations. - Fixed Vanilla capitalization in world managment guide
Contributor
There was a problem hiding this comment.
11 issues found across 67 files (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/plugins_and_modifications/fabric_mods/performance-mods.md">
<violation number="1" location="docs/plugins_and_modifications/fabric_mods/performance-mods.md:12">
P3: The page metadata now contains the typo `Bloom.hos`; use the repository-standard product name `Bloom` instead.
(Based on your team's feedback about using Bloom rather than Bloom.host in documentation.)</violation>
</file>
<file name="docs/using_the_panel/split-server.md">
<violation number="1" location="docs/using_the_panel/split-server.md:16">
P3: The introduction now mixes first-person “Our DuckPanel” with third-person “them,” making the sentence grammatically inconsistent. “DuckPanel allows you to split your server” is clearer and more direct.</violation>
</file>
<file name="README.md">
<violation number="1" location="README.md:47">
P3: The Markdown-guide sentence has awkward singular/plural wording, lowercases “Markdown,” and leaves trailing whitespace. “For more information about using Markdown” is clearer and consistent with the linked page title.</violation>
</file>
<file name="docs/using_the_panel/sftp.md">
<violation number="1" location="docs/using_the_panel/sftp.md:14">
P3: The metadata now contains a case-only duplicate of `File Access`, adding noise without a distinct keyword. Removing the lowercase duplicate would keep the keyword list concise.</violation>
</file>
<file name="docs/plugins_and_modifications/multiplatform/geysermc.md">
<violation number="1" location="docs/plugins_and_modifications/multiplatform/geysermc.md:33">
P3: “DuckPanel panel” repeats the product type and reads awkwardly. “In DuckPanel” matches the terminology used elsewhere in the documentation.</violation>
</file>
<file name="docs/extras/documentation-template.md">
<violation number="1" location="docs/extras/documentation-template.md:14">
P3: The visible link label reverses the established guide name and leaves trailing whitespace. Using “Markdown Syntax Guide” keeps navigation terminology consistent.</violation>
</file>
<file name="docs/VPS/virtfusion-image.md">
<violation number="1" location="docs/VPS/virtfusion-image.md:2">
P3: The guide's source filename remains `virtfusion-image.md` even though its ID, route, sidebar entry, and asset directory now use `virtfusion-iso`, making the page harder for contributors to locate consistently. Renaming the file to `virtfusion-iso.md` would complete this terminology change.</violation>
</file>
<file name="sidebars.js">
<violation number="1" location="sidebars.js:327">
P3: This sidebar entry introduces trailing whitespace, creating avoidable formatting noise and likely failing whitespace checks. Removing the spaces keeps the list consistent with adjacent entries.</violation>
</file>
<file name="docs/plugins_and_modifications/multiplatform/plan.md">
<violation number="1" location="docs/plugins_and_modifications/multiplatform/plan.md:42">
P1: The dashboard will be unreachable when a reader follows the linked reverse-proxy guide's “use any port” instruction, because this configuration makes Plan listen on `8804`. The setup should explicitly create/use an `8804` allocation (or substitute the actual allocated port here).</violation>
<violation number="2" location="docs/plugins_and_modifications/multiplatform/plan.md:73">
P2: Account registration is not complete after submitting the web form: Plan displays a code that must be finalized in-game with `/plan register --code <code>`. Including that step prevents readers from reaching the dashboard with an unregistered account.</violation>
</file>
<file name="docs/running_a_server/java-version.md">
<violation number="1" location="docs/running_a_server/java-version.md:17">
P3: While updating this line, the second sentence is grammatically incomplete: "The default Java 25 for modern Minecraft versions, this should suit most use cases." reads as a comma splice with a missing verb in the first clause. Recommend rephrasing, e.g. "The default is Java 25, which supports modern Minecraft versions and should cover most use cases."</violation>
</file>
Tip: instead of fixing issues one by one fix them all with cubic
Tip: Review your code locally with the cubic CLI to iterate faster.
Tip: cubic used a learning from your PR history. Let your coding agent read cubic learnings directly with the cubic MCP.
Re-trigger cubic
|
|
||
| 2. Go to your bloom panel, click on “Ports and Proxies”, and create a new Allocation with the port “8804”. Once you’re done with that, set the Reverse Proxy Domain to “revproxy-us.bloom.host” (or the EU one if you’re in the EU) | ||
| 1. In the DuckPanel File Manager, open `plugins/Plan/config.yml`. | ||
| 2. Update the following settings. Replace `plan.example.com` with the domain or subdomain you configured in the reverse proxy guide. |
Contributor
There was a problem hiding this comment.
P1: The dashboard will be unreachable when a reader follows the linked reverse-proxy guide's “use any port” instruction, because this configuration makes Plan listen on 8804. The setup should explicitly create/use an 8804 allocation (or substitute the actual allocated port here).
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/plugins_and_modifications/multiplatform/plan.md, line 42:
<comment>The dashboard will be unreachable when a reader follows the linked reverse-proxy guide's “use any port” instruction, because this configuration makes Plan listen on `8804`. The setup should explicitly create/use an `8804` allocation (or substitute the actual allocated port here).</comment>
<file context>
@@ -1,51 +1,81 @@
-2. Go to your bloom panel, click on “Ports and Proxies”, and create a new Allocation with the port “8804”. Once you’re done with that, set the Reverse Proxy Domain to “revproxy-us.bloom.host” (or the EU one if you’re in the EU)
+1. In the DuckPanel File Manager, open `plugins/Plan/config.yml`.
+2. Update the following settings. Replace `plan.example.com` with the domain or subdomain you configured in the reverse proxy guide.
-
</file context>
| ## Verify the Setup | ||
|
|
||
| 1. Open `https://plan.example.com` in your browser, replacing the example address with your domain or subdomain. | ||
| 2. Select **Create Account** and complete the registration form. |
Contributor
There was a problem hiding this comment.
P2: Account registration is not complete after submitting the web form: Plan displays a code that must be finalized in-game with /plan register --code <code>. Including that step prevents readers from reaching the dashboard with an unregistered account.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/plugins_and_modifications/multiplatform/plan.md, line 73:
<comment>Account registration is not complete after submitting the web form: Plan displays a code that must be finalized in-game with `/plan register --code <code>`. Including that step prevents readers from reaching the dashboard with an unregistered account.</comment>
<file context>
@@ -1,51 +1,81 @@
+## Verify the Setup
+
+1. Open `https://plan.example.com` in your browser, replacing the example address with your domain or subdomain.
+2. Select **Create Account** and complete the registration form.
+3. Confirm that the Plan dashboard loads and displays your server's analytics.
+
</file context>
Suggested change
| 2. Select **Create Account** and complete the registration form. | |
| 2. Select **Create Account**, complete the registration form, then run the displayed `/plan register --code <code>` command in-game to finalize the account. |
| - Performance | ||
| - Fabric | ||
| - Bloom.host | ||
| - Bloom.hos |
Contributor
There was a problem hiding this comment.
P3: The page metadata now contains the typo Bloom.hos; use the repository-standard product name Bloom instead.
(Based on your team's feedback about using Bloom rather than Bloom.host in documentation.)
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/plugins_and_modifications/fabric_mods/performance-mods.md, line 12:
<comment>The page metadata now contains the typo `Bloom.hos`; use the repository-standard product name `Bloom` instead.
(Based on your team's feedback about using Bloom rather than Bloom.host in documentation.) </comment>
<file context>
@@ -9,7 +9,7 @@ description: A list of mods that will help combat lag on fabric servers.
- Performance
- Fabric
- - Bloom.host
+ - Bloom.hos
- Pterodactyl Panel
- Minecraft
</file context>
Suggested change
| - Bloom.hos | |
| - Bloom |
| --- | ||
|
|
||
| Bloom.host allows you to split the server that you have with them, for example to run more Minecraft servers for different gamemodes or to run a Discord bot off of your server. | ||
| Our DuckPanel allows you to split the server that you have with them, for example to run more Minecraft servers for different gamemodes or to run a Discord bot off of your server. |
Contributor
There was a problem hiding this comment.
P3: The introduction now mixes first-person “Our DuckPanel” with third-person “them,” making the sentence grammatically inconsistent. “DuckPanel allows you to split your server” is clearer and more direct.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/using_the_panel/split-server.md, line 16:
<comment>The introduction now mixes first-person “Our DuckPanel” with third-person “them,” making the sentence grammatically inconsistent. “DuckPanel allows you to split your server” is clearer and more direct.</comment>
<file context>
@@ -10,10 +10,10 @@ keywords:
---
-Bloom.host allows you to split the server that you have with them, for example to run more Minecraft servers for different gamemodes or to run a Discord bot off of your server.
+Our DuckPanel allows you to split the server that you have with them, for example to run more Minecraft servers for different gamemodes or to run a Discord bot off of your server.
:::important
</file context>
Suggested change
| Our DuckPanel allows you to split the server that you have with them, for example to run more Minecraft servers for different gamemodes or to run a Discord bot off of your server. | |
| DuckPanel allows you to split your server, for example, to run more Minecraft servers for different game modes or to run a Discord bot on your server. |
|
|
||
| You can also see [a formatted version of the template](https://docs.bloom.host/extras/template/) to see what the | ||
| formatted elements will look like when imported into the documentation website. | ||
| You can reference our [Markdown Syntax Guide](https://docs.bloom.host/extras/markdown-syntax-reference/) for further references regarding the use of markdown. |
Contributor
There was a problem hiding this comment.
P3: The Markdown-guide sentence has awkward singular/plural wording, lowercases “Markdown,” and leaves trailing whitespace. “For more information about using Markdown” is clearer and consistent with the linked page title.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 47:
<comment>The Markdown-guide sentence has awkward singular/plural wording, lowercases “Markdown,” and leaves trailing whitespace. “For more information about using Markdown” is clearer and consistent with the linked page title.</comment>
<file context>
@@ -40,35 +40,11 @@ and they can be uploaded to the documentation.
-You can also see [the formatted template](https://docs.bloom.host/extras/templatexample/) to preview how the
-elements will look on the documentation website.
+You can reference our [Markdown Syntax Guide](https://docs.bloom.host/extras/markdown-syntax-reference/) for further references regarding the use of markdown.
---
</file context>
Suggested change
| You can reference our [Markdown Syntax Guide](https://docs.bloom.host/extras/markdown-syntax-reference/) for further references regarding the use of markdown. | |
| You can reference our [Markdown Syntax Guide](https://docs.bloom.host/extras/markdown-syntax-reference/) for more information about using Markdown. |
| If you need help installing plugins, check out our [plugin installation guide](/installing-plugins). | ||
|
|
||
| Once installed, go to the **Ports & Proxies** page on the Bloom.Host panel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server. | ||
| Once installed, go to the **Ports & Proxies** page on the DuckPanel panel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server. |
Contributor
There was a problem hiding this comment.
P3: “DuckPanel panel” repeats the product type and reads awkwardly. “In DuckPanel” matches the terminology used elsewhere in the documentation.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/plugins_and_modifications/multiplatform/geysermc.md, line 33:
<comment>“DuckPanel panel” repeats the product type and reads awkwardly. “In DuckPanel” matches the terminology used elsewhere in the documentation.</comment>
<file context>
@@ -31,7 +30,7 @@ Geyser translates network traffic so Bedrock players can join Java servers. It m
If you need help installing plugins, check out our [plugin installation guide](/installing-plugins).
-Once installed, go to the **Ports & Proxies** page on the Bloom.Host panel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server.
+Once installed, go to the **Ports & Proxies** page on the DuckPanel panel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server.
After assigning the port, update the `port:` value in Geyser's `config.yml` to match your new allocation (if not the default), then restart the server.
</file context>
Suggested change
| Once installed, go to the **Ports & Proxies** page on the DuckPanel panel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server. | |
| Once installed, go to the **Ports & Proxies** page in DuckPanel. Create a new port allocation using `19132`. While it is the default, you can use any available port assigned to your server. |
| :::tip Before You Start | ||
| This page is a **contributor template and style reference**. Copy this file as a starting point for any new documentation page. Sections marked with `(*)` are mandatory. | ||
| :::note Markdown Syntax | ||
| You can also reference our [Syntax Markdown Guide](/extras/markdown-syntax-reference) |
Contributor
There was a problem hiding this comment.
P3: The visible link label reverses the established guide name and leaves trailing whitespace. Using “Markdown Syntax Guide” keeps navigation terminology consistent.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/extras/documentation-template.md, line 14:
<comment>The visible link label reverses the established guide name and leaves trailing whitespace. Using “Markdown Syntax Guide” keeps navigation terminology consistent.</comment>
<file context>
@@ -1,18 +1,17 @@
-:::tip Before You Start
-This page is a **contributor template and style reference**. Copy this file as a starting point for any new documentation page. Sections marked with `(*)` are required; sections marked `if applicable` are optional.
+:::note Markdown Syntax
+You can also reference our [Syntax Markdown Guide](/extras/markdown-syntax-reference)
:::
</file context>
Suggested change
| You can also reference our [Syntax Markdown Guide](/extras/markdown-syntax-reference) | |
| You can also reference our [Markdown Syntax Guide](/extras/markdown-syntax-reference). |
| @@ -0,0 +1,36 @@ | |||
| --- | |||
| id: virtfusion-iso | |||
Contributor
There was a problem hiding this comment.
P3: The guide's source filename remains virtfusion-image.md even though its ID, route, sidebar entry, and asset directory now use virtfusion-iso, making the page harder for contributors to locate consistently. Renaming the file to virtfusion-iso.md would complete this terminology change.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/VPS/virtfusion-image.md, line 2:
<comment>The guide's source filename remains `virtfusion-image.md` even though its ID, route, sidebar entry, and asset directory now use `virtfusion-iso`, making the page harder for contributors to locate consistently. Renaming the file to `virtfusion-iso.md` would complete this terminology change.</comment>
<file context>
@@ -1,8 +1,8 @@
---
-id: virtfusion-image
-title: Mounting an Image in VirtFusion
+id: virtfusion-iso
+title: Mounting a CD/ISO in VirtFusion
hide_table_of_contents: true
</file context>
| 'extras/ping-issues', | ||
| 'extras/mtr', | ||
| 'extras/documentation-template', | ||
| 'extras/markdown-syntax-reference', |
Contributor
There was a problem hiding this comment.
P3: This sidebar entry introduces trailing whitespace, creating avoidable formatting noise and likely failing whitespace checks. Removing the spaces keeps the list consistent with adjacent entries.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At sidebars.js, line 327:
<comment>This sidebar entry introduces trailing whitespace, creating avoidable formatting noise and likely failing whitespace checks. Removing the spaces keeps the list consistent with adjacent entries.</comment>
<file context>
@@ -323,6 +323,8 @@ module.exports = {
'extras/ping-issues',
'extras/mtr',
+ 'extras/documentation-template',
+ 'extras/markdown-syntax-reference',
'extras/account-details',
'extras/available-modpacks',
</file context>
Suggested change
| 'extras/markdown-syntax-reference', | |
| 'extras/markdown-syntax-reference', |
| --- | ||
|
|
||
| Bloom.host offers different versions of Java to suit your server. The default Java 25 for modern Minecraft versions, this should suit most use cases. | ||
| Bloom offers different versions of Java to suit your server. The default Java 25 for modern Minecraft versions, this should suit most use cases. |
Contributor
There was a problem hiding this comment.
P3: While updating this line, the second sentence is grammatically incomplete: "The default Java 25 for modern Minecraft versions, this should suit most use cases." reads as a comma splice with a missing verb in the first clause. Recommend rephrasing, e.g. "The default is Java 25, which supports modern Minecraft versions and should cover most use cases."
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/running_a_server/java-version.md, line 17:
<comment>While updating this line, the second sentence is grammatically incomplete: "The default Java 25 for modern Minecraft versions, this should suit most use cases." reads as a comma splice with a missing verb in the first clause. Recommend rephrasing, e.g. "The default is Java 25, which supports modern Minecraft versions and should cover most use cases."</comment>
<file context>
@@ -14,7 +14,7 @@ keywords:
---
-Bloom.host offers different versions of Java to suit your server. The default Java 25 for modern Minecraft versions, this should suit most use cases.
+Bloom offers different versions of Java to suit your server. The default Java 25 for modern Minecraft versions, this should suit most use cases.
This guide will show you how to change the version of Java if it does not work for your server.
</file context>
Suggested change
| Bloom offers different versions of Java to suit your server. The default Java 25 for modern Minecraft versions, this should suit most use cases. | |
| Bloom offers different versions of Java to suit your server. The default is Java 25, which supports modern Minecraft versions and should cover most use cases. |
Contributor
Author
|
I have to address even more staff Not ready for review yet |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR performs a documentation-wide cleanup focused on consistency, readability, accessibility, and navigation. Changes were applied surgically to preserve existing guide content while aligning pages with the repository’s documentation template.
Key changes
templatexample.mdas the canonical contributor template and retainedtemplate.mdas an unlisted Markdown syntax reference.server.propertiesscreenshot.