ReVanced / revanced-documentation

🗄 Collection of all ReVanced documentation

Home Page:https://revanced.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add an unofficial resources section to complement the official resources

SodaWithoutSparkles opened this issue · comments

Unofficial links shouldn't be presented officially.

So thats why they are marked as unofficial

We can say that unofficial guides are present, but linking to one opposes the false impression of them being trusted. If you think you can manage to convey a correct message, please open a PR.

Maybe redir them to a reddit thread listing unofficial resources?

but linking to one opposes the false impression of them being trusted

Reddit or not, it would still have this issue.

commented

I don't understand the point of having to list out unofficial sources, ReVanced documentation is meant to detail how to use or develop for our own products. It shouldn't be used to advertise other tools/guides/patch sources, those things can be maintained unofficially.

Both points are valid. Check out this scenario:

ReVanced asks you to source your APKs yourself. It is your responsibility. But this prerequisite is challenging for many people. The minority knows what APK files are or ever deals with it. For tht reason, you'd assume, we could add a guide on how to get APK files. But this is not possible, because we can not suggest any distribution site such as APKMirror and co. because they are not affiliated with us or we with them + it isn't reliable such as not providing Spotify or broken versions of Sync for Reddit and so on (remember how it's the users responsibility to source APKs).

This is why it can be beneficial if we link to outside resources that specialize in for example how to source APK files. We can say, it is your responsibility to source APK files, but also help the user by linking them to further resources.

But if it is a user-oriented guide (instead of documentations oriented towards developers), unofficial guides can be updated far more frequently and timely. It is also far more flexible which may be easier to follow for normal user.

The docs are user oriented and not developer oriented and they are frequently updated, unlike unofficial guides.

commented

This is why it can be beneficial if we link to outside resources that specialize in for example how to source APK files. We can say, it is your responsibility to source APK files, but also help the user by linking them to further resources.

I agree it would be beneficial for this one scenario. But linking to unofficial guides such as those found in the Discord server that are app-specific guides would defeat the purpose of our own guides. We should link to unofficial resources that compliment our own documentation, such as where to find APKs, rather than guides that try to replace our own.

commented

The docs are user oriented and not developer oriented and they are frequently updated, unlike unofficial guides.

https://github.com/revanced/revanced-documentation:

But linking to unofficial guides such as those found in the Discord server that are app-specific guides would defeat the purpose of our own guides.

Ideally all of them should be in the official guide. The one thing that lacks in the official guide is images.

The reason that app-spectific guide exists is to provide extra app-spectific troubleshooting steps. For example, where should you put the troubleshooting steps for playback issues in youtube revanced?

@xafn Yes, complementing guides is the idea.

@SodaWithoutSparkles The ReVanced Manager troubleshooting section should not have anything regarding YouTube for example

The ReVanced Manager troubleshooting section should not have anything regarding YouTube for example

Thats the point. So unofficial guides should fill in the gap.

So maybe, for example, the manager troubleshooting section can contain a section for "other troubleshooting materials" with each link marked as [unofficial].

YouTube troubleshooting does not complement ReVanced Manager