docs: Improve documentation #1411
Conversation
There was a problem hiding this comment.
Copilot reviewed 6 out of 18 changed files in this pull request and generated 10 comments.
Files not reviewed (12)
- docs/4_building.md: Evaluated as low risk
- docs/README.md: Evaluated as low risk
- docs/2_2_managing.md: Evaluated as low risk
- SECURITY.md: Evaluated as low risk
- docs/2_1_patching.md: Evaluated as low risk
- docs/0_prerequisites.md: Evaluated as low risk
- docs/2_4_settings.md: Evaluated as low risk
- docs/2_3_updating.md: Evaluated as low risk
- docs/3_troubleshooting.md: Evaluated as low risk
- docs/1_installation.md: Evaluated as low risk
- docs/developer/2_submitting.md: Evaluated as low risk
- docs/developer/README.md: Evaluated as low risk
Comments suppressed due to low confidence (2)
CONTRIBUTING.md:95
- The phrase 'Consider opting for gender-neutral words for language with variations of words based on gender.' should be corrected to 'Consider using gender-neutral words in languages that have gender-based word variations.'
Consider opting for gender-neutral words for language with variations of words based on gender.
README.md:3
- The sentence should be 'To use ReVanced on your Android device, ReVanced Manager has to be installed.'
To use ReVanced on your Android device, ReVanced Manager have to be install,
There was a problem hiding this comment.
Copilot reviewed 6 out of 18 changed files in this pull request and generated 3 comments.
Files not reviewed (12)
- docs/4_building.md: Evaluated as low risk
- docs/3_troubleshooting.md: Evaluated as low risk
- docs/README.md: Evaluated as low risk
- docs/2_2_managing.md: Evaluated as low risk
- docs/2_3_updating.md: Evaluated as low risk
- docs/2_4_settings.md: Evaluated as low risk
- SECURITY.md: Evaluated as low risk
- docs/0_prerequisites.md: Evaluated as low risk
- docs/2_1_patching.md: Evaluated as low risk
- docs/1_installation.md: Evaluated as low risk
- docs/developer/2_submitting.md: Evaluated as low risk
- docs/developer/README.md: Evaluated as low risk
Comments suppressed due to low confidence (8)
docs/developer/1_develop.md:11
- Rephrase to: 'For example, when adding a new feature, you must prefix the description of your commit with
feat:.'
so for example when you're adding a new feature you must add `feat: ` before the description of your commit.
docs/developer/1_develop.md:15
- Rephrase to: 'simply hit the build button on your IDE.'
simply hit build button on your IDE
docs/developer/1_develop.md:7
- Rephrase to: 'The code style follows the guidelines provided at https://kotlinlang.org/docs/coding-conventions.html.'
The styling is based on https://kotlinlang.org/docs/coding-conventions.html
docs/developer/3_verifying.md:6
- The sentence should be rephrased to: 'To distribute ReVanced Manager safely, it is recommended to provide users with a link to'
To distribute ReVanced Manager safely and recommended way is to provide the users with a link to
docs/developer/0_prerequisites.md:8
- The term 'minSdk' should be 'minSdkVersion' for clarity.
higher than the [`minSdk`](/app/build.gradle.kts)
README.md:84
- [nitpick] The phrase 'by downloading from the' is redundant. It should be 'by downloading it from the'.
You can get the most recent version of ReVanced Manager by downloading from the [ReVanced site](https://revanced.app/download).
README.md:86
- [nitpick] The phrase 'by following the documentation' should be more specific. Consider specifying the exact location of the documentation.
Learn how to use ReVanced Manager by following the [documentation](/docs).
README.md:76
- [nitpick] Ensure consistency in punctuation in the list of features. Some items end with periods, while others do not.
- 💉 **Patch apps**: Apply any patch of your choice to Android apps
|
|
||
| The certificate SHA-256 of the APK will always be `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` unless otherwise noted. | ||
|
|
||
| [installation authenticity]: /docs/1_installation.md#%EF%B8%8F-verifying-authenticity-of-revanced-manager |
There was a problem hiding this comment.
The link syntax is incorrect and should be corrected to: '[installation authenticity]: /docs/1_installation.md#verifying-authenticity-of-revanced-manager'
| [installation authenticity]: /docs/1_installation.md#%EF%B8%8F-verifying-authenticity-of-revanced-manager | |
| [installation authenticity]: /docs/1_installation.md#verifying-authenticity-of-revanced-manager |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
|
||
| ### Authenticating to GitHub Registry | ||
|
|
||
| ReVanced Manager uses dependency from the GitHub Registry (i.e., [ReVanced Patcher](https://github.com/ReVanced/revanced-patcher/packages)) and so your build may fail without authenticating to the service, |
There was a problem hiding this comment.
The phrase should be 'ReVanced Manager uses dependencies from the GitHub Registry' to correct the grammar.
| ReVanced Manager uses dependency from the GitHub Registry (i.e., [ReVanced Patcher](https://github.com/ReVanced/revanced-patcher/packages)) and so your build may fail without authenticating to the service, | |
| ReVanced Manager uses dependencies from the GitHub Registry (i.e., [ReVanced Patcher](https://github.com/ReVanced/revanced-patcher/packages)) and so your build may fail without authenticating to the service, |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
|
||
| We're accepting translations on [Crowdin](https://translate.revanced.app) | ||
| You can find the documentation for ReVanced Manager [here](/docs). |
There was a problem hiding this comment.
[nitpick] This line is redundant since documentation is already mentioned in line 87.
| You can find the documentation for ReVanced Manager [here](/docs). | |
| ## ⚖️ License |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
finally, 1 million other unnecessary change after, it's ready |
| ### ✒️ Verifying authenticity of ReVanced Manager | ||
|
|
||
| > [!NOTE] | ||
| > It's always advisable that you download from trusted sources like the [ReVanced site][Official ReVanced Download] | ||
| > or GitHub releases as it's the safest way to download ReVanced without potential risk of malware. | ||
|
|
||
| To verify if your ReVanced Manager is provided without sign of tampering, | ||
| we have signed the APK with hashes corresponding to `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` *unless otherwise stated*. | ||
|
|
There was a problem hiding this comment.
This does not seem like enough information for a user to successfully verify an APK.
There was a problem hiding this comment.
Yes, the official Android docs to verify the APK should be referenced and/or the official documented method should be mentioned here.
| > [!Note] | ||
| > If the **Install** Button isn't there, it could be that something went wrong. Refer to [3. ❔ Troubleshooting](3_troubleshooting.md) | ||
| > [!Tip] |
There was a problem hiding this comment.
This does not seem to render correctly
There was a problem hiding this comment.
Nested note blocks don't render unfortunately. See how the main branch solves this.
| @@ -8,16 +8,26 @@ The following pages will guide you through using ReVanced Manager to patch apps. | |||
| 2. Tap the + button in the bottom right corner | |||
| @@ -8,16 +8,26 @@ The following pages will guide you through using ReVanced Manager to patch apps. | |||
| 2. Tap the + button in the bottom right corner | |||
| 3. Choose an app to patch[^1] | |||
| 4. Tap on the version of the app you want to patch[^2] | |||
There was a problem hiding this comment.
You have to select from storage unless you have downloader plugins installed, which is not mentioned here.
| ### Additional Requirements | ||
|
|
||
| - A device with root capabilities using the latest version of [KernelSU](https://github.com/tiann/KernelSU) or [Magisk](https://github.com/topjohnwu/Magisk) |
There was a problem hiding this comment.
This is not required unless you are working on root features.
There was a problem hiding this comment.
This could be reworded into optional requirements signalling that this requirement does not have to be met.
Co-authored-by: Ax333l <[email protected]>
Co-authored-by: Ax333l <[email protected]>
Co-authored-by: Ax333l <[email protected]>
Co-authored-by: Ax333l <[email protected]>
| @@ -12,7 +12,10 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev | |||
| 3. [🔄 Updating ReVanced Manager](2_3_updating.md) | |||
| 4. [⚙️ Configuring ReVanced Manager](2_4_settings.md) | |||
| 3. [❔ Troubleshooting](3_troubleshooting.md) | |||
| 4. [🔨 Building from source](4_building.md) | |||
|
|
|||
| ## 🧑💻 Developing for ReVanced Manager | |||
There was a problem hiding this comment.
This section is not present in our other repos. It should be present in the readme, or added to other repos consistently.
| @@ -12,7 +12,10 @@ 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.
I believe the new compose manager has new features that probably need a separate page, such as managing patches. The current page structure needs to be adjusted for compose.
| - An Android device running Android 8 or higher | ||
| - Android device running Android 8.0 or higher | ||
|
|
||
| ### Optional Requirements |
There was a problem hiding this comment.
Instead of a title, just say "Optionally, root access ..."
| @@ -1,14 +1,26 @@ | |||
| # ⬇️ Installation | |||
|
|
|||
| In order to use ReVanced on your Android device, ReVanced Manager must be installed. | |||
| To use ReVanced on your Android device, ReVanced Manager have to be install, | |||
| refer to the [Prerequisites](0_prerequisites.md) if haven't already. | |||
There was a problem hiding this comment.
Each page has an icon so if linking to one the icon should be present in it. Linking back is not necessary here though, as we don't do it consistently in other pages.
|
|
||
| 1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest) | ||
| 1. Get the latest version of ReVanced Manager from the [ReVanced site][Official ReVanced Download]. |
There was a problem hiding this comment.
The wording in the main branch is better than here.
| 2. Install ReVanced Manager | ||
|
|
||
| ### ✒️ Verifying authenticity of ReVanced Manager |
There was a problem hiding this comment.
This should be step 3, if at all, not a separate title. However this section can be removed entirely, verifying can be added consistently later in all repos.
| ### ✒️ Verifying authenticity of ReVanced Manager | ||
|
|
||
| > [!NOTE] | ||
| > It's always advisable that you download from trusted sources like the [ReVanced site][Official ReVanced Download] | ||
| > or GitHub releases as it's the safest way to download ReVanced without potential risk of malware. | ||
|
|
||
| To verify if your ReVanced Manager is provided without sign of tampering, | ||
| we have signed the APK with hashes corresponding to `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` *unless otherwise stated*. | ||
|
|
There was a problem hiding this comment.
Yes, the official Android docs to verify the APK should be referenced and/or the official documented method should be mentioned here.
|
|
||
| To verify if your ReVanced Manager is provided without sign of tampering, | ||
| we have signed the APK with hashes corresponding to `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` *unless otherwise stated*. | ||
|
|
||
| ## ⏭️ What's next | ||
|
|
||
| The next page will guide you through using ReVanced Manager. |
There was a problem hiding this comment.
Wording in main branch is better than here.
| > [!Note] | ||
| > If the **Install** Button isn't there, it could be that something went wrong. Refer to [3. ❔ Troubleshooting](3_troubleshooting.md) | ||
| > [!Tip] |
There was a problem hiding this comment.
Nested note blocks don't render unfortunately. See how the main branch solves this.
| [^2]: It is suggested to use the version with the most patches to get the most out of ReVanced. | ||
| [^3]: Mounting the patched app on top of the original app will only work if the installed app version matches the version of the app selected in step 4. above. | ||
|
|
||
| ### Change patch selection and options |
There was a problem hiding this comment.
Once again, this should not be a separate section, follow how the main branch does it.
Guide to use the application will be seperate from this PR
Split
Need help