5.0.0 Docs?

Are there any docs on the v5.0.0 API? I’ve been looking around and can’t find any references to v5.0.0 docs.

If you mean javadocs for the 5.0.0 API, you can find them here

The problem is API5 isn’t actually released. What is released is snapshots / pre-releases.

Until API5 is released, snapshots can and will have breaking changes. It’s nicknamed “bleeding” in the development repositories.

If people attempted to write docs(meaning docs.spongepowered.org, in a tutorial like fashion + translation) There would be significant wasted effort as things continue to change in the snapshots.

This also means that plugins written for API5 must continue to be updated daily, or at least tested, against the latest API5 changes every time a new snapshot is generated. Fine for development, but can be an utter pain for releases.

The reason why JavaDocs remain up to date, is that it’s good practise for JavaDocs to be written as the code is written, however, JavaDocs arn’t as nicely searchable, indexable, or sorted by topic like docs.spongepowered.org is.

That said, I highly recommend learning to read the API code directly, as well as using the JavaDocs as it will help you to become a better coder, and allow you to develop against the API5 changes before the Docs team has had a chance to write them. You could even help assist in creating the Documentation! http://github.com/SpongePowered/SpongeDocs/

Ah! Thank you very much.

Most has been said above, but i’ll add some words for clarification:

The docs team usually waits until a proper API release (aka 5.0.0) has been made before updating the docs to the new version. The past has shown that the docs team struggles to keep up with all the changes (and possible reverts) introduced by the devs on the bleeding branch while a new version matures.
Thus it was decided to wait till the new version is out and update the docs afterwards.

Nevertheless you can read the javadocs of the bleeding branch right now and develop against it. But expect stuff breaking while doing so :wink:

1 Like