docs: part 7

Co-authored-by: Ushie <ushiekane@gmail.com>
2025-05-02 14:54:25 +02:00 · 2023-10-21 22:43:40 +07:00 · 2023-10-21 22:43:40 +07:00 · f14b697769
commit f14b697769
parent d06fb08239
14 changed files with 62 additions and 26 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -48,24 +48,24 @@ This document describes how to contribute to ReVanced Manager.

 ## 📖 Resources to help you get started
 * The [documentation](/docs/README.md) provides steps to build ReVanced Manager from source
-* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
+* Our [backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
 * [Issues](https://github.com/ReVanced/revanced-manager/issues) are where we keep track of bugs and feature requests

 ## 🙏 Submitting a feature request
 Features can be requested by opening an issue using the
-[Feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).
+[feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).

 > [!NOTE]
-> We may rejected your request at the discretion of maintainers,
-> please provides good motivation for a request to be accepted.
+> We may reject your request at the discretion of ReVanced Manager's maintainers,
+> please provide good motivation for a request to be accepted.

 ## 🐞 Submitting a bug report
 If you encounter a bug while using the ReVanced Manager app, open an issue using the
-[Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
+[bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).

 ## 📝 How to contribute
 > [!NOTE]
-> It's worth noting that we recommended that you discuss your changes with 
+> It's worth noting that we recommend that you discuss your changes with 
 > the maintainers of ReVanced Manager before contributing. 
 > This will help you determine whether your change is acceptable.

@ -77,7 +77,7 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using
   Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager

 ## 🤚 I want to contribute but don't know how to code
-Even if you don't know how to code, you can still help us by
-translate the ReVanced Manager application at [Crowdin](https://translate.revanced.app/).
+Even if you don't know how to code, you can still contribute by 
+translating the ReVanced Manager application on our [Crowdin](https://translate.revanced.app/).

 ❤️ Thank you for considering contributing to ReVanced Manager.
--- a/README.md
+++ b/README.md
@ -51,15 +51,16 @@ ReVanced Manager is an Android application that uses ReVanced Patcher to add, re

 ### 💪 Features
 We provide the some of the features are:
-* 📱 ReVanced Patcher that fit in your pocket!
-* 🤗 Friendly & intuitive UI to help you manage your patched applications!
-* 🛠️ Lots of customization to patch using 3rd-party sources and integration!
-* ✨ And a lot more!
+* 📱 **Portable**: ReVanced Patcher that fit in your pocket!
+* 🤗 **Intuitive UI**: Help you manage your patched applications *intuitively*!
+* 🛠️ **Customization**: Patch using 3rd-party sources and integration!
+* ✨ And a **lot more!**

 ### 🔽 Download
-You can obtain ReVanced Manager by downloading it from either [revanced.app/download](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases)
+You can obtain ReVanced Manager by downloading it from either [ReVanced site](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases)

 ## 🌱 Miscellaneous
+
 ### 📄 Documentation
 Step on how to use the application are available [here](/docs/README.md).

@ -67,7 +68,7 @@ Step on how to use the application are available [here](/docs/README.md).
 Thanks for consider contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md).

 ### 🔴 Issues
-For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
+For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose).

-### ⚖️ License
+## ⚖️ License
 ReVanced Manager adopt the [GNU General Public License 3.0](/LICENSE), [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3): You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
--- a/docs/0_prerequisites.md
+++ b/docs/0_prerequisites.md
@ -1,13 +1,16 @@
 # 💼 Prerequisites
+
 In order to use ReVanced Manager, certain requirements must be met.

 ## 🤝 Requirements
+
 - An Android device running Android 8 or higher
 - Any device architecture except ARMv7[^1]

 [^1]: This constraint only applies to patches, that require patching APK resources which is why some patches may or may not work on ARMv7 architecture. You can find out, which architectures your device supports here: [⚙️ Configuring ReVanced Manager](2_4_settings.md#%E2%84%B9%EF%B8%8F-about).

 ## ⏭️ What's next
+
 The next page will guide you through patching an app.

 Continue: [⬇️ Installation](1_installation.md)
--- a/docs/1_installation.md
+++ b/docs/1_installation.md
@ -1,11 +1,14 @@
 # ⬇️ Installation
+
 In order to use ReVanced on your Android device, ReVanced Manager must be installed.

 ## ✅ Installation steps
+
 1. Download the latest version of ReVanced Manager from [here](https://github.com/ReVanced/revanced-manager/releases/latest)
 2. Install ReVanced Manager

 ## ⏭️ What's next
+
 The next page will guide you through using ReVanced Manager.

 Continue: [🛠️ Usage](2_usage.md)
--- a/docs/2_1_patching.md
+++ b/docs/2_1_patching.md
@ -1,7 +1,9 @@
 # 🧩 Patching apps
+
 The following pages will guide you through using ReVanced Manager to patch apps.

 ## ✅ Steps to patch apps
+
 1. Navigate to the Apps tab from the top navigation bar
 2. Tap the + button in the bottom right corner
 3. Choose an app to patch[^1]
@ -17,6 +19,7 @@ The following pages will guide you through using ReVanced Manager to patch apps.
 [^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.

 ## ⏭️ What's next
+
 The next page will bring you back to the usage page.

 Continue: [🛠️ Usage](2_usage.md)
--- a/docs/2_2_managing.md
+++ b/docs/2_2_managing.md
@ -1,11 +1,14 @@
 # 🧰 Managing patched apps
+
 After patching an app, you may want to manage it. This page will guide you through managing patched apps.

 ## ✅ Steps to manage patched apps
+
 1. Navigate to the Apps tab from the top navigation bar
 2. Select the app you want to manage
 <!-- What happen to this? @BenjaminHalko -->
 3. 
+
 ## ⏭️ What's next

 The next page will bring you back to the usage page.
--- a/docs/2_3_updating.md
+++ b/docs/2_3_updating.md
@ -1,10 +1,13 @@
 # 🔄 Updating ReVanced Manager
+
 In order to keep up with the latest features and bug fixes, it is recommended to keep ReVanced Manager up to date.

 ## ✅ Updating steps
+
 > Currently not implemented

 ## ⏭️ What's next
+
 The next page will bring you back to the usage page.

 Continue: [🛠️ Usage](2_usage.md)
--- a/docs/2_4_settings.md
+++ b/docs/2_4_settings.md
@ -1,29 +1,39 @@
 # ⚙️ Configuring ReVanced Manager
+
 ReVanced Manager has settings that can be configured to your liking.

 ## ⭐ Essential settings
+
 - ### 🔗 API URL
+
  Specify the URL of the API to use. This is used to fetch ReVanced Patches and update ReVanced Manager.

 - ### 🧬 Sources
+
  Override the API and change the source of ReVanced Patches.

 - ### 🧪 Experimental ReVanced Patches support
+
  Lift app version constraints from ReVanced Patches. This allows you to patch any version of an app, even if the patch is not explicitly compatible with it.

 - ### 🧑‍🔬 Experimental universal support
+
  This will show or hide ReVanced Patches, which are not meant for any app in particular but rather for all apps but may not work on all apps.

 - ### 🔑 Export, import or delete keystore
+
  Manage the keystore used to sign patched apps.

 - ### 📄 Export, import or reset ReVanced Patches selection
+
  Manage the ReVanced Patches selection. This is useful if you want to share your ReVanced Patches selection with others or reset it to the default selection.

 - ### ℹ️ About
+
  View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device.

 ## ⏭️ What's next
+
 The next page will bring you back to the usage page.

 Continue: [🛠️ Usage](2_usage.md)
--- a/docs/2_usage.md
+++ b/docs/2_usage.md
@ -1,13 +1,16 @@
 # 🛠️ Usage
+
 The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager.

 ## 📖 Table of contents
+
 1. [🧩 Patching apps](2_1_patching.md)
 2. [🧰 Managing patched apps](2_2_managing.md)
 3. [🔄 Updating ReVanced Manager](2_3_updating.md)
 4. [⚙️ Configuring ReVanced Manager](2_4_settings.md)

 ## ⏭️ What's next
+
 The next page will guide you through troubleshooting ReVanced Manager.

 Continue: [❔ Troubleshooting](3_troubleshooting.md)
--- a/docs/3_troubleshooting.md
+++ b/docs/3_troubleshooting.md
@ -1,18 +1,24 @@
 # ❔ Troubleshooting
 In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions.
+
 - 💉 Patching fails with an error
+
  Make sure ReVanced Manager is up to date by following [🔄 Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches.
  
 - 💥 App not installed as package conflicts with an existing package
+
  An existing installation of the app you're trying to patch is conflicting with the patched app. Uninstall the existing app before installing the patched app.

 - ❗️ Error code `135`, `139` or `1` when patching the app
+
  Your device is not supported. Refer to the [Prerequisites](0_prerequisites.md) page for supported devices.

  Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app.

 - 🚫 Non-root install is not possible with the current patches selection
+
  Select the **Default** button when choosing patches.

 - 🚨 Patched app crashes on launch
+
  Select the **Default** button when choosing patches.
--- a/docs/README.md
+++ b/docs/README.md
@ -1,7 +1,9 @@
 # 💊 ReVanced Manager
+
 This documentation explains how to use [ReVanced Manager](https://github.com/ReVanced/revanced-manager).

 ## 📖 Table of contents
+
 0. [💼 Prerequisites](0_prerequisites.md)
 1. [⬇️ Installation](1_installation.md)
 2. [🛠️ Usage](2_usage.md)
@ -12,9 +14,10 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV
 3. [❔ Troubleshooting](3_troubleshooting.md)

 ## 👋 Developer version
-Are you a contributors? Consider checking out developer version of the [documentation](/developers/README.md).
+Interested in contributing? Consider checking out developer version of the [documentation](/developers/README.md).

 ## ⏭️ Start here
+
 The next page will tell you about the prerequisites for using ReVanced Manager.

 Continue: [💼 Prerequisites](0_prerequisites.md)
--- a/docs/developers/0_preparation.md
+++ b/docs/developers/0_preparation.md
@ -1,19 +1,17 @@
-# 💼 Preparing a developer environment
+# 💼 Preparing a development environment
 In order to compile ReVanced Manager, certain requirements must be met.

 ## 📝 Prerequisites
 * Kotlin IDE such as [Android Studio](https://developer.android.com/studio)
-* Understanding of [Android](https://android.com) development, [Kotlin](https://kotlinlang.org/) language and [Jetpack Compose](https://developer.android.com/jetpack/compose).
-* At least Java Development Kit version 17 of any vendors
+* Knowledge of [Android](https://android.com) App development, [Kotlin](https://kotlinlang.org/) language.
+* At least JDK 17 of any vendors

 ## 🏃 Prepare the environment
 1. Clone the repository
   ```sh
   git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager
   ```
-<!-- This assume that you can use Maven repository -->
 2. Build the APK
-   Release variant:
   ```sh
   gradlew assembleRelease -Psign
   ```
--- a/docs/developers/1_overview.md
+++ b/docs/developers/1_overview.md
@ -7,7 +7,7 @@ build beautiful and performant user interfaces using declarative programming.
 It provides a unified and efficient way of building UI that is well-integrated with the Android framework. 

 ## 📂 Structure
-We structure our code to use MVVM (Model-View-ViewModel) architecture for easier maintenance of the code. 
+We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. 

 * **Model**: responsible for retrieving & storing data as well as performing calculations and other operations
 * **View**: responsible for displaying the UI to the user, and send inputs to **ViewModel**
@ -15,8 +15,8 @@ We structure our code to use MVVM (Model-View-ViewModel) architecture for easier

 ## 🧑‍💻 Code readability
 In order to maintain readability of the code, It's highly recommend that you follow 
-https://developer.android.com/jetpack/compose/api-guidelines style guide in order to maintain
-consistent readability through out the codebase. 
+https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain
+consistent style through out the codebase. 

 ## 🎨 Design language
 We adopt the [Material Design 3](https://m3.material.io) as our design language to 
@ -34,5 +34,5 @@ Example:
 * `fix`(**settings**): NullPointerException when exporting logs
 * `refactor`: optimize sub-optimal code
 * `perf`(**api**): reduces network latency
-* `docs`(**developer**): concise wording
+* `docs`(**developer**): correct grammatical mistak
 * `build`: bump version to v1.9.3
--- a/docs/developers/README.md
+++ b/docs/developers/README.md
@ -2,7 +2,7 @@
 This documentation explains how the [ReVanced Manager](https://github.com/ReVanced/revanced-manager) work.

 ## 📖 Table of contents
-0. [💼 Preparing a developer environment](0_preparation.md)
+0. [💼 Preparing a development environment](0_preparation.md)
 1. [💁 Overview](1_overview.md)

 ## ⏭️ Start here