Improve documentation quality

[SodaWithoutSparkles]

• [ ] Add detailed guide on how to get openjdk

Details

For Zulu:

winget install --id Azul.Zulu.17.JDK

For Adoptium/Temurin:

winget install --id EclipseAdoptium.Temurin.17.JDK

For Microsoft:

winget install --id Microsoft.OpenJDK.17

• [ ] detailed how-to guide on how to re-log microG in another .md file to prevent it getting too long

Example

# no internet connection symptomes: offline, no internet caused by: change of password, etc. solution: re-login microG. Consult [wiki: re-log microG](link) for details.

• Add wireframe as visual reference

image

[oSumAtrIX]

Please edit & update the issue body & title instead of making a new comment

[oSumAtrIX]

Add detailed guide on how to get openjdk

This is too off-topic for the scope of ReVanced, and it's documentation. The requirement is to have the SDK installed, how you do it, is not relevant to ReVanced.

[SodaWithoutSparkles]

Add detailed guide on how to get openjdk

This is too off-topic for the scope of ReVanced, and it's documentation. The requirement is to have the SDK installed, how you do it, is not relevant to ReVanced.

Ofc not at the main page. Create another resources section for downloading/installing. Or redir to other resources like the arch wiki.

[oSumAtrIX]

At max a footer can be added to things like the requirements, that link to the places. For example the Java JDK requirement can have a footer to the Java JDK download page

[SodaWithoutSparkles]

At max a footer can be added to things like the requirements, that link to the places. For example the Java JDK requirement can have a footer to the Java JDK download page

That is a solution. But using winget is probably more efficient and harder to screw up. Thats the whole reason that I want a separate page. Linking them w/o providing any explanations is not the proper thing to do.

Sth like:

---

To get openjdk-17, you can choose one of the following varients:

• Zulu (recommended)
• Adoptium
• Microsoft

Zulu

To install the Zulu openjdk-17, visit their official site to download, or paste the following in a powershell window to run winget if you are on windows:

winget install --id Azul.Zulu.17.JDK

Visit the official website for detailed installation guide on Windows, debian-based Linux distros, or macOS.

[oSumAtrIX]

Winget is microsoft windows specific. This guide is not

[SodaWithoutSparkles]

How about the edited one

E: Sorry for double comment, github mobile being github mobile sometimes.

[oSumAtrIX]

Too complicated. Asking Java as a prerequisite and linking to where to get it is enough. Downloading and installing Java isn't a concern of this guide.

[aksel]

It would be helpful to have a visual reference for some UI patches. For example, when patching YouTube, I found it difficult to figure out what the Hide Info Cards patch referred to. Confusingly, there's a similar sounding Hide Info Panels option in layout options, but I'm unsure whether they're related. I remain unsure what UI elements I hide if I apply the patch and enable that option.

Having a visual reference would clear it right up. Some are obvious, but many are not.

Not sure if this is what you refer to by wireframe, apologies if my comment is redundant.

[SodaWithoutSparkles]

@aksel That seems like there should be a documentation for, but maybe in the patches repo. @oSumAtrIX your thoughts?

[oSumAtrIX]

Descriptions can be used

[aksel]

Some of them are still quite cryptic, in my opinion.

Take for example hide-album-cards, which is described as "Hides the album cards below the artist description.". I can sorta guess my way around it, but it would be very helpful to just show a screenshot instead to remove any doubt.