docs: init (#911)

Co-authored-by: afn <_@afn.lol>

docs/0_prerequisites.md

@@ -0,0 +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 application.
+
+Continue: [⬇️ Installation](1_installation.md)

docs/1_installation.md

@@ -0,0 +1,14 @@
+# ⬇️ Installation
+
+In order to use ReVanced on your Android device, ReVanced Manager must be installed.
+
+## 🪜 Installation steps
+
+- Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest)
+- Install ReVanced Manager
+
+## ⏭️ What's next
+
+The next page will guide you through patching an application.
+
+Continue: [🪛 Usage](2_usage.md)

docs/2_1_patching.md

@@ -0,0 +1,29 @@
+# 🧩 Patching applications
+
+The following pages will guide you through using ReVanced Manager to patch applications.
+
+## 🪜 Steps to patch applications
+
+1. Navigate to the **Patcher** tab from the bottom navigation bar
+2. Tap on the **Select an application** card
+3. Choose an application to patch[^1]
+   > **Note**: The application version suggested by ReVanced Manager is visible in each application's card. This is important in step 5. below, as most patches are compatible with this version.
+4. Tap on the **Select patches** card and select the patches you want to apply[^2]
+   > **Warning**: If you see a warning icon next to a patch, it means that the patch is not compatible with the application version you selected in step 3. above. In this case, you should either go back and select a different application version or deselect the patch.
+5. Tap on the **Done** button to confirm your selection
+6. Tap on the **Patch** button to start patching
+   > **Warning**: The patching process can take anywhere from 2 to 5 minutes depending on your device. Refrain from exiting ReVanced Manager while the process is still running, otherwise the patching time will increase significantly.
+7. After patching is complete, tap on the **Install** button to install the patched application
+   > **Note**: If you have root access on your device, you may have the option to mount the patched application on top of the original application.[^4]
+   > Optionally, you may tap on the three vertical dots in the top right to export the patched application to storage.
+
+[^1]: You may be prompted to select an application from storage in case you have no root access on your device. In this case, select the APK file from your device storage.[^3]
+[^2]: It is suggested to use the default set of patches by tapping on the **Default** chip above the list of patches.
+[^3]: You can obtain `.apk` files from sites such as [APKMirror](https://www.apkmirror.com/).
+[^4]: Mounting the patched application on top of the original application will only work if the installed application version matches the version of the application selected in step 3. above.
+
+## ⏭️ What's next
+
+The next page will bring you back to the usage page.
+
+Continue: [🛠️ Usage](2_usage.md)

docs/2_2_managing.md

@@ -0,0 +1,16 @@
+# 🧰 Managing patched applications
+
+After patching an application, you may want to manage it. This page will guide you through managing patched applications.
+
+## 🪜 Steps to manage patched applications
+
+1. Tap on the **Dashboard** tab in the bottom navigation bar
+2. Select the **Installed** chip
+3. Tap on the **Info** button for the application you want to manage
+4. Choose one of the options from the menu
+
+## ⏭️ What's next
+
+The next page will bring you back to the usage page.
+
+Continue: [🛠️ Usage](2_usage.md)

docs/2_3_updating.md

@@ -0,0 +1,14 @@
+# 🔄 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
+
+1. Navigate to the **Dashboard** tab from the bottom navigation bar
+2. Tap on the **Update** button in the **Updates** section
+
+## ⏭️ What's next
+
+The next page will bring you back to the usage page.
+
+Continue: [🛠️ Usage](2_usage.md)

docs/2_4_settings.md

@@ -0,0 +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 application version constraints from ReVanced Patches. This allows you to patch any version of an application, 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 application in particular but rather for all applications but may not work on all applications.
+
+- ### 🔑 Export, import or delete keystore
+
+  Manage the keystore used to sign patched applications.
+
+- ### 📄 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)

docs/2_usage.md

@@ -0,0 +1,16 @@
+# 🛠️ Usage
+
+The following pages will guide you through using ReVanced Manager to patch applications, manage patched applications, and update ReVanced Manager.
+
+## 📖 Table of contents
+
+1. [🧩 Patching applications](2_1_patching.md)
+2. [🧰 Managing patched applications](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)

docs/3_troubleshooting.md

@@ -0,0 +1,27 @@
+# 🛟 Troubleshooting
+
+In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions.
+
+- ### 💥 App not installed as package conflicts with an existing package
+
+  An existing installation of the application you're trying to patch is conflicting with the patched application. Uninstall the existing application before installing the patched application.
+
+- ### ❗️Error code `135`, `139` or `1` when patching the application
+
+  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 application.
+
+- ### 🚫 Non-root install is not possible with the current patches selection
+
+  Select the **Default** chip when choosing patches.
+
+- ### 🚨 Patched application crashes on launch
+
+  Select the **Default** chip when choosing patches.
+
+## ### ⏭️ What's next
+
+The next page will teach you how to build ReVanced Manager from source.
+
+Continue: [🛠️ Building from source](4_building.md)

docs/4_building.md

@@ -0,0 +1,40 @@
+# 🛠️ Building from source
+
+This page will guide you through building ReVanced Manager from source.
+
+1. Setup the Flutter environment for your [platform](https://docs.flutter.dev/get-started/install)
+
+2. Clone the repository
+
+   ```sh
+   git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager
+   ```
+
+3. Create a GitHub personal access token with the `read:packages` scope [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced)
+
+4. Add your GitHub username and the token to `~/.gradle/gradle.properties`
+
+   ```properties
+   gpr.user = YourUsername
+   gpr.key = ghp_longrandomkey
+   ```
+
+5. Get dependencies
+
+   ```sh
+   flutter pub get
+   ```
+
+6. Delete conflicting outputs
+
+   ```sh
+   flutter packages pub run build_runner build --delete-conflicting-outputs
+   ```
+
+   > **Note**: Must be run every time you sync your local repository with the remote repository.
+
+7. Build the APK
+
+   ```sh
+   flutter build apk
+   ```

docs/README.md

@@ -0,0 +1,15 @@
+# 💊 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)
+   1. [🧩 Patching applications](2_1_patching.md)
+   2. [🧰 Managing patched applications](2_2_managing.md)
+   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)