This repository was archived by the owner on Nov 7, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Nov 7, 2026. It is now read-only.
proposal: documentation structure overhaul #231
Description
Is there an existing issue for this?
- I have searched existing issues, it hasn't been reported yet
Use case description
I'm opening this issue to propose a structural overhaul of the documentation. While reviewing the site, I noticed two main things:
- A significant portion of the content was last updated over a year ago.
- The scope is primarily tailored for Spigot/Paper and proxies (Velocity/BungeeCord), with no clear path for adding content for other platforms like Fabric.
Since this would be a significant change, I wanted to open this issue for discussion and feedback before starting any work on a pull request.
Looking forward to hearing your thoughts!
Proposed solution (optional)
To help bring the documentation up to date and make it more scalable for the future, I've planned out a new directory structure:
introduction/
getting-started/
installation/
server-customization/
administration-and-maintenance/
optimization/
troubleshooting/
advanced-topics/
The new server-customization/ section, for example, could be structured like so to create clear, parallel paths for different platforms:
+-- server-customization/
| +-- index.md # Explains the difference between plugins and mods
| +-- bukkit-plugins/ # All Spigot/Paper plugin guides go here
| +-- fabric-mods/ # A dedicated home for Fabric mod guides
The goals of this new structure are:
- To create a more step-by-step flow for new/existing server admins.
- To establish a clear path for adding guides for other platforms like Fabric.
- To consolidate scattered information into more logical categories.
Activity
ukdaaan commentedon Oct 12, 2025
I think this is certainly a great idea, we've mainly focused on delivering "spigot/bukkit" and it's forks because that's generally speaking the most common thing for players and where I spent a large majority of my years. If you're not already in the Discord perhaps it would be worth joining to discuss?
Again, apologies for no response, I had not received notification about the issue.
muhdfdeen commentedon Oct 13, 2025
Hi @ukdaaan, no worries at all on the late response. I'm happy to discuss this further.
I tried to reach out on Discord, but it seems your privacy settings do not allow for DMs or friend requests at the moment. My username is @muhdfdeen. If you'd like to continue the conversation in the Discord server, feel free to ping me.
ukdaaan commentedon Oct 15, 2025
Pinged a msg in the server, thanks!
@ everyone else - this Issue will remain open
ukdaaan commentedon Oct 17, 2025
UPDATE: You can view the development of this revamp using https://preview.setup.md - Feedback is welcome