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

Update wiki #282

Merged
merged 10 commits into from
Jun 20, 2024
Merged

Update wiki #282

merged 10 commits into from
Jun 20, 2024

Conversation

SoSeDiK
Copy link
Contributor

@SoSeDiK SoSeDiK commented Jun 14, 2024

Started updating wiki. Among the changes:

  • Added FAQ.
  • Removed legacy code.
    • Things like NBTFile/NBTChunk are still showcased.
    • Info about 1.7.10 and NBTInjector is moved to FAQ.
  • Added examples of alternatives, new syntax and features.
    • More showcases of NBT class, explaining the basics, subtags, lists.
    • Info and examples of resolve methods.
    • Examples working with items, tiles, entities, blocks and known caveats when doing so.
    • Interface proxies.
    • Some general things like difference between ItemStack object nbt and NBT.get.
  • Examples page showing some simple real-world use-cases.

Things left:

  • More info about editing ItemMeta. Warn about never mixing meta and nbt.
  • Check whether all links work.

Things to consider:

  • Outdated NBT-API explanation might use a better/clearer wording?
  • Maybe add some small descriptions to plugins in plugins page?

Copy link

what-the-diff bot commented Jun 14, 2024

PR Summary

  • README and curseforge.md updates
    This PR resolves a minor typo and introduces a link directing to the use of Gradle in the project.

  • Deletion of wiki on Minecraft Objects Conversion
    The file dealing with converting Minecraft objects to NBT and Strings has been deleted.

  • Renaming and Updating Code Examples
    A file, initially titled "Set-a-skull's-skin-using-NBT-API.md", has been renamed to "Example-Usages.md", with additional code examples supplementing the existing content.

  • FAQ.md Enhancement
    The modification in FAQ.md includes an added entry concerning the update of NBT-API, and a new note about the usability of old versions of certain components.

  • Home.md Typo Fix and Version Changes
    This edits correct a typo in the title and modifies the range of Spigot and Paper versions that NBT-API supports.

  • Additional Plugins in Plugins.md
    New plugins utilizing NBT-API have been included.

  • Emphasis on Artifact Selection in Using-Gradle and Using-Maven
    An important note has been added, highlighting the proper artifactId to use instead of shading the "-plugin" artifact.

  • Using-the-NBT-API.md Code Examples and Info Addition
    Additional code examples and relevant details have been included in this file, providing more extensive information about NBT files and methods of using the NBT API.

  • Sidebar Link Modifications
    The sidebar now has changes including the removal of "Using NBT API" link, addition of an "FAQ" link, removal and addition of links under "General", "Code Examples" and "Extras" sections respectively.

@SoSeDiK SoSeDiK marked this pull request as ready for review June 15, 2024 21:04
@SoSeDiK SoSeDiK marked this pull request as draft June 15, 2024 23:03
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@tr7zw
Copy link
Owner

tr7zw commented Jun 20, 2024

Branch is getting merged, more work will be done in later pr's.

@tr7zw tr7zw marked this pull request as ready for review June 20, 2024 20:11
@tr7zw tr7zw merged commit ffa6126 into tr7zw:master Jun 20, 2024
1 check passed
@SoSeDiK SoSeDiK deleted the wiki branch July 1, 2024 12:24
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