Fix readme file not populating on the correct docs versions#711
Fix readme file not populating on the correct docs versions#711Buckminsterfullerene02 wants to merge 1 commit intomainfrom
Conversation
- 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
Maybe it's not the right place to discuss, but in my opinion people should use and make mods for the experimental version. |
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. |
|
Converting to draft to get it out of the way until it's ready to be merged. |
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?
cargo binstall --no-confirm mdbook-mermaidmdbook-mermaid install docs-export/cargo binstall --no-confirm mdbook-alertspython docs-export/export.pypython docs-repo/build.pydocs-repo/docs/and then open index.html and view readmeRelease readme changes:


Dev readme:

No change to the build instructions
Any release tag version (e.g. v3.0.0):

