docs: init (#1224)

.github/workflows/update-documentation.yml

@@ -0,0 +1,19 @@
+name: Update documentation
+
+on:
+  push:
+    paths:
+      - docs/**
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    name: Dispatch event to documentation repository
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
+          repository: revanced/revanced-documentation
+          event-type: update-documentation
+          client-payload: '{"repo": "${{ github.event.repository.name }}", "ref": "${{ github.ref }}"}'

README.md

@@ -32,3 +32,24 @@ By using Material 3 and Material You, we are ensuring that the app's user interf
 * **Better performance:** Jetpack Compose uses the power of the Android framework to provide smooth and fast performance, which enhances the user experience.
 * **Modern and efficient UI development:** Jetpack Compose provides a modern and efficient way of building UI, which makes it easier for developers to create beautiful and performant user interfaces.
 
+## 🔽 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)
+
+## 📝 Prerequisites
+
+For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md)
+
+## 🔴 Issues
+
+For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose).
+
+## 🌐 Translation
+
+[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced)
+
+We're accepting translations on [Crowdin](https://translate.revanced.app)
+
+## 🛠️ Building Manager from source
+
+For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md)

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 app.
+
+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
+
+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)

docs/2_1_patching.md

@@ -0,0 +1,25 @@
+# 🧩 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]
+4. Tap on the version of the app you want to patch[^2]
+5. Select the patches you want to apply
+6. Tap the Patch button
+7. Tap on the **Install** button
+   > **Note**: If you are rooted, you can mount the patched app on top of the original app.[^3]
+   > Optionally, you may export the patched app to storage using the options in the top right corner.
+
+[^1]: Non-root users may be prompted to select an APK from storage, in which case you have to source the APK file yourself. ReVanced does not provide any APK files.
+[^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.
+
+## ⏭️ 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,15 @@
+# 🧰 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
+3. 
+## ⏭️ 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,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)

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 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)

docs/2_usage.md

@@ -0,0 +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)

docs/3_troubleshooting.md

@@ -0,0 +1,31 @@
+# ❔ 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.
+
+## ⏭️ 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,38 @@
+# 🛠️ Building from source
+
+This page will guide you through building ReVanced Manager from source.
+
+1. Download Java SDK 17 ([Azul JDK](https://www.azul.com/downloads/?version=java-17-lts&package=jdk#zulu) or [OpenJDK](https://jdk.java.net/java-se-ri/17)) and add it to path
+
+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. Set the `sdk.dir` property in `local.properties` to your Android SDK location
+
+   ```properties
+   sdk.dir = /path/to/android/sdk
+   ```
+
+6. Build the APK
+
+   Debug:
+   ```sh
+   ./gradlew assembleDebug
+   ```
+
+   Release:
+   ```sh
+   ./gradlew assembleRelease -Psign
+   ```

docs/README.md

@@ -0,0 +1,21 @@
+# 💊 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 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)
+3. [❔ Troubleshooting](3_troubleshooting.md)
+4. [🔨 Building from source](4_building.md)
+
+## ⏭️ Start here
+
+The next page will tell you about the prerequisites for using ReVanced Manager.
+
+Continue: [💼 Prerequisites](0_prerequisites.md)