#docs

1 messages ยท Page 1 of 1 (latest)

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Missing required version field in the PaperMC download OpenAPI specification. (https://api.papermc.io/openapi)

https://swagger.io/specification/#info-object

The specifications requires for the info object to have both the title, and the version.

The PaperMC OpenAPI specification is missing the version field.
Is:

  "info": {
    "title": "PaperMC API"
  },

Should be:

  "info": {
    "title": "PaperMC API"
    "version": "FOO"
  },

(I'm not necessarily...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

I would also love a quick section about sql injection and why its important to use prepared statements

oh, and while at it, we need a big red box about never accessing DB/IO/etc on the main thread

generally, I think our docs should be more like a high level explainer on concepts and lead the user to do a bit research themselves instead of feeling like a full blown tutorial (we arent a good authority on such general java/programming knowledge), but idk what others think

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

This section miss the strict-advancement-dimension-check option (default to false). You can look here: https://github.com/PaperMC/Paper/blob/master/patches/server/0834-Add-option-for-strict-advancement-dimension-checks.patch
by default bukkit consider some world that are similar to the main world as the main world for custom world unlike vanilla that does strict equality here.
This section also miss the chat-threads section:
![image](https://github.com/PaperMC/docs/assets/41980282/37c53048...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Because if one server doesn't have the port in order, you wouldn't be able to connect to it, and because I haven't seen it mentioned anywhere in the documentation I thought it would help people troubleshoot faster over a simple issue that is port ordering.

But if you prefer to not mention it or mentioning it in another way, its totally fine by me.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

Now that I think of it, "This is useful for sending clickable messages to players," sounds weird considering we (and Spigot) have native support for chat components. I feel like this might be a leftover in the bungee docs from a time where this native integration didn't exist yet. Maybe we're better off removing this entire part? I don't really see the purpose for this channel anymore apart from the aforementioned option of using it to send messages to players on a different server.

lost sealBOT
lost sealBOT
lost sealBOT
#

The main reason iirc why these options are in the unsupported setting is not really the lag or enabling them, it is more that we do not promise these to keep working down the line.

If upstream fixes this accidentally, or even mojang, we are not going out of our way to re-implement these settings.
If enabling them absolutely crashes your server, it is probably still a good idea to let us know lol.

lost sealBOT
lost sealBOT
#

Ok, this is ready for review now. The basic logic behind what version to display to the user is:

  • If the URL contains the version string, then we load the maximum version for that major. IE the dev guide will display 1.19.4 if we are using the 1.19 versioned docs.

  • On the other hand, if we are using the latest docs then we can just return the highest Paper version.

SoftwareVersionFetcher

In order to use this, there are some caveats. When it is placed inline within markdo...

lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feature/userdev
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: paper/player-reloot-time
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: temporary-config-page
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: feature/component/i18n
lost sealBOT
#
[PaperMC/docs] branch deleted: paper/player-reloot-time
lost sealBOT
lost sealBOT
#

I have added all the behaviour of a native code block and changed the way that the versions work.

Embedded Versions:

Before, we had:

import SoftwareVersionFetcher from "@site/src/minecraft-versioning/SoftwareVersionFetcher";

The valid versions are 1.13 - { SoftwareVersionFetcher.getMajorPaperVersion() }.

However this only supports synchronous getMajorPaperVersion calls, so I have had to move this to a component:

The valid versions are 1.13 - <SoftwareVe...
lost sealBOT
#

A question that gets asked often is "Should I use Velocity, Waterfall or BungeeCord". While the existing page already answer that, its a lot to read and contains plenty of details that most server owners just looking for a simple answer aren't interested in.

This PR adds a small markdown table with a comparison matrix to the top of that doc page. It makes it easy to see at a glance what Velocity does, and what it doesn't do - mainly, supporting plugins made for BungeeCord, another question...

lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: bugfix/remove-lag-compensate-block-breaking-from-config
lost sealBOT
#
[PaperMC/docs] branch deleted: bugfix/remove-lag-compensate-block-breaking-from-config
lost sealBOT
#
[PaperMC/docs] New branch created: hangar-publishing
lost sealBOT
#
[PaperMC/docs] branch deleted: hangar-publishing
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: contributing/events
lost sealBOT
lost sealBOT
lost sealBOT
#

If you haven't any differences between BungeeCord and Waterfall, or you aren't willing to document them, you may want to remove one of the columns entirely.

There are differences. Waterfall guarantees Slf4j and exposes it in the API. On BungeeCord this library happens to be provided, but only due to the recent circumstance of library loading. Moreover, Waterfall has miscellaneous performance improvements to the implementation. I believe there might be a few new events. If we can get https:...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

This PR adds a button that lets you expand or collapse all the config descriptions at once. I've also taken the liberty of fixing some of the linter warnings I was getting, as well as some weird issues that I ran into while attempting to implement this feature.

I've also attached a showDescriptions parameter to the Config component that defaults to false. Setting it to true will expand all the descriptions initially. It might be useful to show all descriptions for smaller configs by ...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

This PR replaces the anchor element used for the config nodes with the button element. clean-btn and button--link are applied to render the button the same as an anchor element, and config-node is used for any leftover stylings required to keep visual parity.

https://github.com/PaperMC/docs/assets/43185817/62efe4ca-4f5b-4e59-a836-8655f46ad953

Near the end of the video I notice a weird inconsistency with the config descriptions for the hidden-blocks and replacement-blocks showi...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

I think I would remove the border around the files, make them proper links, and remove the color from the folder, since they are not links
I also would want to expand this to include all files paper creates. not every file (like the whitelist or the usercache or whatever) need a whole page, maybe those could have a popup when you click on them with a short text? that popup could be reused for the config files that arent documented yet.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

generally, I have a really meh feeling about this. its nice that we have a place where we can say that people should depend on the package including the version, but the rest needs a bit more meat to be useful.
it also needs a ton of disclaimers and stuff that API should always be preferred, that using internals can cause damage if you dont know what you are doing, that there is no support, etc
I also dont like using the legacy, misleading, NMS term so often. its important that we explain ...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
The internal CraftBukkit code is relocated to `org.bukkit.craftbukkit.<version>`. This means that any attempts to reflect
must include the version. For example, `org.bukkit.craftbukkit.v1_20_R1.CraftServer` is the class for the server in
version 1.20.1. You can access these classes easily with some reflection utilities.

I don't really like this part personally

For example, org.bukkit.craftbukkit.v1_20_R1.CraftServer is the class for the server in
version 1.20.1.

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

As communicated in the discord I took the initiative to add a tutorial for creating a project with help of the Minecraft Development IntelliJ plugin.

I did not yet take a look at typos or grammar and just want to gather some feedback for the overall structure.
I also changed the current project-setup markdown file to manual-project-setup.
The new_project_filled.png currently is not in use. This might or might not be added later.
For the list to explain the fields when creating...

lost sealBOT
lost sealBOT
#

Alright,
I changed a few things:

  • I moved project-setup and mcdev-project-setup to a separate subsection project-setup
  • I changed the list to a table
  • I reverted the slug

Now, with those changes I don't think we should leave the current project setup tutorial named "Paper Project Setup" since it should be obvious that we try to create a paper project. And it would look better if its just named "Project Setup" and the other one is called "McDev Project Setup". Maybe even just...

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: update_1.20.2
lost sealBOT
#
[PaperMC/docs] branch deleted: update_1.20.2
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: feat/seperate_topics
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: update_docusaurus_v3
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

3.0 is out now. Looking at the changes between this pr and the actual release it should just be a matter of updating the packages.

The primary change is an update from MDX v2 to the newly released MDX 3

This sounds pretty major (i.e. v1 -> v2), but its actually just a few very small changes, hence why it was added at the very end. We don't inferface with MDX directly hence no changes are needed. ...

lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/remove-village-exploit-docs
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] branch deleted: fix/remove-village-exploit-docs
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#

don't really see why this is useful:

  1. plugins already exist that do this including one shipped by LP
  2. nobody would realistically be hardcoding the format like that, it should be using placeholders instead
  3. now we have to maintain docs based on an entirely external plugin

would be better to make it generic, just having a "how to use a configurable format" and then just have the example be MiniMessage with placeholders and a little "add your own here!" bit or something

lost sealBOT
lost sealBOT
lost sealBOT
lost sealBOT
#
[PaperMC/docs] New branch created: fix/velocity_title_page
lost sealBOT