Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify which version apply to the live documentation #207

Closed
LelouBil opened this issue Nov 24, 2024 · 4 comments · Fixed by #208
Closed

Clarify which version apply to the live documentation #207

LelouBil opened this issue Nov 24, 2024 · 4 comments · Fixed by #208
Labels
meta Changes to non-content parts of the docs.

Comments

@LelouBil
Copy link

LelouBil commented Nov 24, 2024

Hello, I am writing this issue because I got very confused about this section of the documentation

https://docs.neoforged.net/docs/blockentities/#creating-and-registering-block-entities

In the header, the version is listed as 1.21.x, so I thought that using the 1.21 MDK (linked in the documentation) would allow me to use the registration example, however after having errors and looking around in the neoforged repos, I found out that the constructor used in the documentation was actually added to neoforged 1.21.2, and the 1.21 MDK is using 1.21.1.

I am not sure if this is an issue with the documentation versioning (1.21.x using 1.21.2 only features) or the 1.21 MDK not using the latest 1.21 version ? (But on https://projects.neoforged.net/neoforged/neoforge 1.21.2 is listed as Beta, so I am not sure).

Or maybe the 1.21.x version of the documentation should specify 1.21.2+ and/or specify that it applies to a neoforged version currently in Beta.

@ChampionAsh5357
Copy link
Contributor

ChampionAsh5357 commented Nov 25, 2024

The versioning works similar to the NeoForge repo, except we don't make new docs for versions that didn't have that many major changes.

The .x branches always refer to the latest neoforge version (beta counts as well, as we are only using it as a marker that breaking changes are still allowed in the internals). Any other version works as a maximum bound. You can see the available versions in the dropdown in the top right corner. Currently, there is 1.20.4, 1.20.6, 1.21.1, and 1.21.x. This means that the doc range covers [1.20.3, 1.20.4], [1.20.5, 1.20.6], [1.21, 1.21.1], and [1.21.2, 1.21.3], respectively. 1.21.4, as there are a lot of changes, will be migrated to 1.21.x, where 1.21.3 will have its own subsection.

Changing the versioning numbers is possible, but I also don't think it not something that couldn't be handled with a change to the main page as well.

@ChampionAsh5357 ChampionAsh5357 added the meta Changes to non-content parts of the docs. label Nov 25, 2024
@LelouBil
Copy link
Author

Thanks for the clarification about the documentation versioning. I think always listing the specific version(s) instead of ".x" would be easier for users of the documentation.

Something should also be done for the MDK linked in the "Getting Started" section, currently the documentation links an MDK that doesn't match the version of the code examples inside that same documentation version.

@LelouBil
Copy link
Author

LelouBil commented Dec 2, 2024

Thank you very much! However the linked MDK for 1.21.2-1.21.3 is still the 1.21 MDK, that uses NeoForge for 1.21.1

@LelouBil
Copy link
Author

LelouBil commented Dec 2, 2024

Maybe this should be a separate issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Changes to non-content parts of the docs.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants