README.md documentation link open blank docs page

[TiEmKej]

Would you change the link to "lastest" branch of docs, so readers wouldn't have to change it manually?

[PerchunPak]

There are no docs for v10 because they were added in unreleased v11. And we can't use docs from v11 for v10 because v11 changed public interfaces a lot (see #306 and #335).

Although, if you want to try new features - just use release candidate, it's pretty stable!

pip install mcstatus>=11.0.0rc1

---

Not closing this, because we probably should add some warning to stable tag.

[kevinkjt2000]

Nope, not changing the readme link because people kept coming into our Discord server saying that the "latest" docs were not matching up with the newest stable version which they thought was "latest".

A warning/disclaimer on stable for a short while wouldn't hurt. Another idea would be to rename "latest" on readthedocs to something like "pre-release" or "testing" to make it obvious that it is part of development still.

[PerchunPak]

A warning/disclaimer on stable for a short while wouldn't hurt. Another idea would be to rename "latest" on readthedocs to something like "pre-release" or "testing" to make it obvious that it is part of development still.

Or just add another tag.

[kevinkjt2000]

What I was driving at is that "latest" is not a very descriptive label. Latest of what? stable? beta? from development? release on PyPi? I'd say that most people would assume "latest" corresponds with the latest released version and not realize that there are some pre-releases out at the moment since pip defaults to not installing pre-releases.

Of course once v11 is out, this naming scheme on readthedocs would matter less.

[PerchunPak]

Then, we can rename latest to development or master.

[ItsDrike]

Once v11 is out, the naming indeed wouldn't matter that much, and latest isn't that bad label when shown next to stable, most python documentation sites use these, so it's usually obvious what they are, but I wouldn't mind a rename to development if possible.

[kevinkjt2000]

Okay, I've made a temporary preview of what v10 docs could look like on this branch https://mcstatus.readthedocs.io/en/docs-on-v10/

If these are looking okay for v10, then I'll release a v10.0.4 version to promote these into "stable" on readthedocs. With plans to null-merge all of this into master via the backports branch that I also pushed, since many of these files have had significant changes in v11.

[ItsDrike]

The advanced usage shows mcproto.dns functions, which we determined weren't a part of the public API, and so they were removed later, they probably shouldn't be there. The entire advanced usage section can be removed, and the dns docs should be moved under internal data. You can probably cherry pick that off of some Perchunk Pak's commit, as I already requested this change in some PR before (though it might've been fixed via a force push instead, potentially making cherry picking hard).

[PerchunPak]

19e2446

[kevinkjt2000]

Can close this now that v11 is out with all the doc changes.