docs: Improve documentation #1411
Conversation
Axelen123
added
the
ReVanced Manager Compose
|
@validcube what is the status of this PR? |
All of the essential are done (consistency with other ReVanced repository might not be guaranteed); I'm separating additional documentation changes into another PR so that this PR won't get locked up. |
Co-authored-by: KobeW50 <84587632+KobeW50@users.noreply.github.com>
This commit removes the developer version, preventing this PR from being locked up with additional developer experiences.
| Continuing the legacy of Vanced | ||
| </p> | ||
|
|
||
| # 👋 Contribution guidelines |
There was a problem hiding this comment.
Should this be "Contribution guidelines" or "ReVanced Manager contribution guidelines"
the second one is consistent with ReVanced Patches repository
Co-authored-by: Palm <palmpasuthorn@gmail.com>
Heading 1 -> 2 -> 3 not 1 -> 3
|
What is the status of this? It might make sense to split out the README and contribution guidelines into a separate PR if the other documentation will take time to finish |
|
Guide to use This PR will only improve general documentation like README.md and CONTRIBUTING.md, but include changes like spellcheck in other areas. |
merge changes from `dev` (flutter)
| <!-- What happen to this? @BenjaminHalko --> | ||
| 3. |
| @@ -12,7 +12,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev | |||
| 3. [🔄 Updating ReVanced Manager](2_3_updating.md) | |||
There was a problem hiding this comment.
Updating has been implemented. The file is out of date (It is also not showing up in the github review page for some reason!)
|
|
||
| We provide the some of the features are: | ||
|
|
||
| * 📱 **Portable**: ReVanced Patcher that fit in your pocket; |
There was a problem hiding this comment.
This sounds kinda weird. What does "portable" mean here and how is it beneficial?
There was a problem hiding this comment.
This sounds kinda weird. What does "portable" mean here and how is it beneficial?
I have to generate 4 compelling points or reasons to use the ReVanced Manager 💀
Any suggestion would be great.
There was a problem hiding this comment.
I've seen some consistency errors with our other repositories while skimming through this PR. It would be a good idea first to restore this consistency and then apply the change consistently across all involved repositories. An example of an inconsistency is that other repositories have an "About" section, such as ReVanced CLI, or the merge difference in language and wording.
Apart from that, there are some unfinished sections that already have been commented on as well as the patching page, which features no more note blocks about warnings and pitfalls. It may be a good idea to incorporate them if applicable to restore completeness.
Guide to use the application will be seperate from this PR
Split