-
-
Notifications
You must be signed in to change notification settings - Fork 734
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
docs: Improve documentation #1411
base: compose-dev
Are you sure you want to change the base?
Conversation
Continuing the legacy of Vanced | ||
</p> | ||
|
||
# 👋 Contribution guidelines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be "Contribution guidelines" or "ReVanced Manager contribution guidelines"
the second one is consistent with ReVanced Patches repository
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say the second one
Co-authored-by: Palm <[email protected]>
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is still incomplete
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updating has been implemented. The file is out of date (It is also not showing up in the github review page for some reason!)
README.md
Outdated
|
||
We provide the some of the features are: | ||
|
||
* 📱 **Portable**: ReVanced Patcher that fit in your pocket; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds kinda weird. What does "portable" mean here and how is it beneficial?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Script Execution UTC Time: null Signed-off-by: validcube <[email protected]>
Script Execution UTC Time: null Signed-off-by: validcube <[email protected]>
Signed-off-by: validcube <[email protected]>
Guide to use the application will be seperate from this PR
Split