Skip to content

Modernize and standardize Bloom documentation - #430

Merged
ClumsyAdmin merged 59 commits into
Bloom-host:masterfrom
JustAMatt:master
Aug 12, 2026
Merged

Modernize and standardize Bloom documentation#430
ClumsyAdmin merged 59 commits into
Bloom-host:masterfrom
JustAMatt:master

Conversation

@JustAMatt

@JustAMatt JustAMatt commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR modernizes and standardizes BloomDocs across 127 files. It brings guides in line with the current contributor template, refreshes outdated instructions, repairs broken content, and improves consistency, accessibility, navigation, and site presentation.

Key changes

  • Standardized frontmatter, descriptions, heading hierarchy, table-of-contents behavior, section structure, terminology, capitalization, code formatting, and Bloom/DuckPanel naming across VPS, billing, panel, server, plugin/mod, and game guides.
  • Reworked the Plan, Squaremap, MOTD, Velocity, world management, whitelist, Spark, and legacy Timings guides with clearer installation, configuration, verification, compatibility, port, and reverse-proxy guidance.
  • Refreshed plugin and mod documentation, including installation requirements, Geyser, Simple Voice Chat, performance guidance, Java versions, and numerous plugin-specific links and instructions.
  • Updated DuckPanel and account workflows covering SFTP, schedules, server importing, split servers, users, backups, ports and proxies, file management, billing, and related common tasks.
  • Expanded VPS documentation with a new VirtFusion CD/ISO mounting guide and asset, plus revised rescue mode, VNC, Windows installation, credentials, and subuser guidance.
  • Updated game and other-server documentation for Palworld, Hytale, Rust, Terraria, ARK, NamelessMC, and related server-management topics.
  • Replaced the old template pages with a clearer Documentation Template and Markdown Syntax Reference, added them to the sidebar, and simplified the README contribution guidance.
  • Fixed broken links and image references, added descriptive image alt text and video titles, improved link labels, and removed obsolete screenshots, notices, keywords, and redundant copy.
  • Improved sidebar organization, Getting Started and 404 content, common-task links, and previous/next navigation.
  • Refreshed Docusaurus metadata and footer branding, replaced the externally hosted page-header logo with a styled local asset, and improved responsive header presentation.

@JustAMatt
JustAMatt requested a review from ClumsyAdmin July 30, 2026 18:51
@JustAMatt JustAMatt self-assigned this Jul 30, 2026
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
bloomdocs ✅ Ready (View Log) Visit Preview c7f52be

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 117 files

Tip: instead of fixing issues one by one fix them all with cubic

Re-trigger cubic

Comment thread src/theme/MDXContent/index.js Outdated
Comment thread docs/running_a_server/timings.md Outdated
Comment thread docs/plugins_and_modifications/multiplatform/simple-voice-chat.md Outdated
Comment thread docs/running_a_server/motd.md Outdated
Comment thread docs/VPS/virtfusion-vnc.md
Comment thread docs/other-servers/namelessmc.md Outdated
Comment thread docs/other-servers/namelessmc.md
Comment thread docs/running_a_server/motd.md Outdated
Comment thread README.md Outdated
Comment thread docs/running_a_server/timings.md Outdated
JustAMatt and others added 3 commits July 30, 2026 16:11
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>
JustAMatt and others added 2 commits July 30, 2026 16:16
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>
@JustAMatt

Copy link
Copy Markdown
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

@JustAMatt

Copy link
Copy Markdown
Contributor Author

Should be ready for review now @ClumsyAdmin

@JustAMatt

Copy link
Copy Markdown
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

@JustAMatt

Copy link
Copy Markdown
Contributor Author

Good to review

@JustAMatt
JustAMatt requested a review from ClumsyAdmin August 3, 2026 15:23

@ClumsyAdmin ClumsyAdmin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more small pass and we should be good 😁

Comment thread src/theme/MDXContent/index.js Outdated
Comment thread docs/games/palworld/update.md Outdated
Comment thread docs/games/palworld/update.md Outdated
# Method 2
---

## Method 2

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be ### since it's a method for updating the server (under the main ##)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread docs/plugins_and_modifications/multiplatform/plan.md
Comment thread docs/running_a_server/whitelist.md Outdated
hide_table_of_contents: false
sidebar_label: Setting up Whitelist
description: How to set up Whitelist on Java/Bedrock
description: How to set up a whitelist on Java or Bedrock

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still needs to be capitalized as its the subject

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this commit doesn't modify this file, still needs to be capitalized

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to get my hopes up but I think I finally got the doc b8141f9

I'm sorry I'm so bad at reading smh

Comment thread docs/extras/documentation-template.md
Comment thread docs/games/rust/connecting.md Outdated
Comment thread docs/games/terraria/connecting.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 5 files (changes from recent commits).

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.

Re-trigger cubic

Comment thread docs/plugins_and_modifications/multiplatform/plan.md Outdated
Comment thread docs/plugins_and_modifications/multiplatform/plan.md Outdated
Comment thread docs/plugins_and_modifications/multiplatform/plan.md
Comment thread docs/extras/documentation-template.md
Comment thread docs/games/rust/connecting.md Outdated
Comment thread docs/extras/documentation-template.md Outdated
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>
JustAMatt and others added 2 commits August 12, 2026 09:47
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>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/plugins_and_modifications/multiplatform/plan.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/running_a_server/whitelist.md Outdated
Comment thread docs/running_a_server/whitelist.md Outdated
JustAMatt and others added 2 commits August 12, 2026 10:28
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>
@ClumsyAdmin ClumsyAdmin changed the title General fixes and reformatting to match template + general tweaks Modernize and standardize Bloom documentation Aug 12, 2026
@ClumsyAdmin
ClumsyAdmin merged commit 7e95045 into Bloom-host:master Aug 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants