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

Fix readme file not populating on the correct docs versions #711

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Buckminsterfullerene02
Copy link
Member

@Buckminsterfullerene02 Buckminsterfullerene02 commented Dec 7, 2024

Description

Currently, ue4ss home page and release tag (i.e. v3.0.1) shows the instructions for building ue4ss against main branch, which is incorrect, and has lead to a lot of confusion where people are trying to build C++ mods against main branch, while having stable version of ue4ss installed, which don't work. This is especially bad current as the build system is different between v3.0.1 and dev version.

Adds proper caution tags to the top of the readme depending on the version being viewed

Also edit readmes for non-dev versions that reflects the correct way to clone the repository

How Has This Been Tested?

  1. Run following commands in order:
    cargo binstall --no-confirm mdbook-mermaid
    mdbook-mermaid install docs-export/
    cargo binstall --no-confirm mdbook-alerts
    python docs-export/export.py
    python docs-repo/build.py
  2. Open docs-repo/docs/ and then open index.html and view readme

Release readme changes:
image
image

Dev readme:
image
No change to the build instructions

Any release tag version (e.g. v3.0.0):
image
image

- currently, ue4ss home page and release tag (i.e. v3.0.1) shows the instructions for building ue4ss against main branch, which is incorrect, and has lead to a lot of confusion where people are trying to build mods against main branch, while having latest version of ue4ss installed
- also add proper caution tags to the top of the readme depending on the version being viewed
- also edit readmes for non-dev versions that reflects the correct way to clone the repository
@igromanru
Copy link
Contributor

Currently, ue4ss home page and release tag (i.e. v3.0.1) shows the instructions for building ue4ss against main branch, which is incorrect

Maybe it's not the right place to discuss, but in my opinion people should use and make mods for the experimental version.
In experimental version a lot of bugs were fixed + all new game releases which use 5.3 and up require it anyway.
I would even like to suggest to release a new stable version ASAP or make the experimental version easier to find.
The stable version doesn't even work for some games like Hogwarts Legacy (4.27) anymore. I can't remember the reason but the "stable" version is simply old and a lot happened on all ends (Pseudo, patternsleuth etc.)
Also as mod developer I find xmake easier to use and I'm glad that I don't have to install and deal with cmake. It might change back to cmake later, but currently xmake is alright as long there are no problems.

@Buckminsterfullerene02
Copy link
Member Author

Buckminsterfullerene02 commented Dec 7, 2024

Currently, ue4ss home page and release tag (i.e. v3.0.1) shows the instructions for building ue4ss against main branch, which is incorrect

Maybe it's not the right place to discuss, but in my opinion people should use and make mods for the experimental version. In experimental version a lot of bugs were fixed + all new game releases which use 5.3 and up require it anyway. I would even like to suggest to release a new stable version ASAP or make the experimental version easier to find. The stable version doesn't even work for some games like Hogwarts Legacy (4.27) anymore. I can't remember the reason but the "stable" version is simply old and a lot happened on all ends (Pseudo, patternsleuth etc.) Also as mod developer I find xmake easier to use and I'm glad that I don't have to install and deal with cmake. It might change back to cmake later, but currently xmake is alright as long there are no problems.

You are very correct, and I think that perhaps this PR should only be merged after the next major release. Because this is still a bug with the docs site, but I think that for now having the "wrong" readme at the front is fine.

Just to clarify, we usually don't want to have the developer docs readme in the stable docs area, because the C++ mod ABI breaks frequently within the experimental version, which makes it a very, very bad idea to have C++ mods developed on, as they will break frequently.

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