feat: init docs

docusaurus/docs/guide/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "Guide",
+    "position": 1,
+    "link": {
+        "type": "generated-index"
+    }
+}

docusaurus/docs/guide/revanced-cli/0_prerequisites.md

@@ -0,0 +1,9 @@
+# 💼 Prerequisites
+
+To use ReVanced CLI, you will need to fulfill certain requirements.
+
+## 🤝 Requirements
+
+- Java SDK 11 (Azul JDK or OpenJDK)
+- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device
+- An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7)

docusaurus/docs/guide/revanced-cli/1_usage.md

@@ -0,0 +1,76 @@
+# 🛠️ Using ReVanced CLI
+
+Learn how to ReVanced CLI.
+
+## ⚡ Setup ADB
+
+1. Ensure that ADB is working
+
+   ```bash
+   adb shell exit
+   ```
+
+   If you want to deploy the patched APK file on your device by mounting it on top of the original APK file, you will need root access. This is optional.
+
+   ```bash
+   adb shell su -c exit
+   ```
+
+2. Get the name of your device
+
+   ```bash
+   adb devices
+   ```
+
+## 🔨 Using ReVanced CLI
+
+- ### ⚙️ Show all available options for ReVanced CLI
+
+  ```bash
+  java -jar revanced-cli.jar -h
+  ```
+
+- ### 📃 List all available patches from supplied patch bundles
+
+  ```bash
+  java -jar revanced-cli.jar
+   -b revanced-patches.jar \
+   -l # Names of all patches will be in kebab-case
+  ```
+
+- ### 💉 Use ReVanced CLI to patch an APK file but deploy without root permissions
+
+  This will deploy the patched APK file on your device by installing it.
+
+  ```bash
+  java -jar revanced-cli.jar \
+   -a input.apk \
+   -o patched-output.apk \
+   -b revanced-patches.jar \
+   -d device-name
+  ```
+
+- ### 👾 Use ReVanced CLI to patch an APK file but deploy with root permissions
+
+  This will deploy the patched APK file on your device by mounting it on top of the original APK file.
+
+  ```bash
+  adb install input.apk
+  java -jar revanced-cli.jar \
+   -a input.apk \
+   -o patched-output.apk \
+   -b revanced-patches.jar \
+   -e vanced-microg-support \
+   -d device-name \
+   --mount
+  ```
+
+  > **Note**: Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also require [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. ReVanced Patcher will merge ReVanced Integrations automatically, depending on if the supplied patches require them.
+
+- ### ⚙️ Supply options to patches using ReVanced CLI
+
+  Some patches provide options. Currently, ReVanced CLI will generate and consume an `options.json` file at the location that is specified in `-o`. If the option is not specified, the options file will be generated in the current working directory.
+
+  The options file contains all options from supplied patch bundles.
+
+  > **Note**: The `options.json` file will be generated at the first time you use ReVanced CLI to patch an APK file for now. This will be changed in the future.

docusaurus/docs/guide/revanced-cli/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "ReVanced CLI",
+    
+    "position": 3,
+    "link": {
+        "type": "generated-index"
+    }
+}

docusaurus/docs/guide/revanced-manager/0_prerequisites.md

@@ -0,0 +1,10 @@
+# 💼 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_usage/4_settings.md).

docusaurus/docs/guide/revanced-manager/1_installation.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+---
+
+# ⬇️ 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://revanced.app/download)
+2. Install ReVanced Manager

docusaurus/docs/guide/revanced-manager/2_usage/1_patching.md

@@ -0,0 +1,25 @@
+---
+sidebar_position: 4
+---
+
+# 🧩 Patching apps
+
+The following pages will guide you through using ReVanced Manager to patch apps.
+
+## 🪜 Steps to patch apps
+
+1. Navigate to the **Patcher** tab from the bottom navigation bar
+2. Tap on the **Select an app** card
+3. Choose an app to patch[^1]
+   > **Note**: The suggested version is visible in each app's card.
+4. Tap on the **Select patches** card and select the patches you want to apply[^2]
+   > **Warning**: If you see a warning you can click on it for more information.
+5. Tap on the **Done** then **Patch** button
+   > **Warning**: The patching process may take ~5 minutes. Exiting the app may increase the time it takes to patch.
+6. 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 default set of patches by tapping on the **Default** button above the list of patches.
+[^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 3. above.

docusaurus/docs/guide/revanced-manager/2_usage/2_managing.md

@@ -0,0 +1,14 @@
+---
+sidebar_position: 5
+---
+
+# 🧰 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. Tap on the **Dashboard** tab in the bottom navigation bar
+2. Select the **Installed** chip
+3. Tap on the **Info** button for the app you want to manage
+4. Choose one of the options from the menu

docusaurus/docs/guide/revanced-manager/2_usage/3_updating.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# 🔄 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

docusaurus/docs/guide/revanced-manager/2_usage/4_settings.md

@@ -0,0 +1,37 @@
+---
+sidebar_position: 7
+---
+
+# ⚙️ 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.

docusaurus/docs/guide/revanced-manager/2_usage/_category_.json

@@ -0,0 +1,6 @@
+{
+    "label": "🛠️ Usage",
+    "link": {
+        "type": "generated-index"
+    }
+}

docusaurus/docs/guide/revanced-manager/3_troubleshooting.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 8
+---
+
+# 🛟 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_usage/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.

docusaurus/docs/guide/revanced-manager/4_building.md

@@ -0,0 +1,44 @@
+---
+sidebar_position: 9
+---
+
+# 🛠️ 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
+   ```

docusaurus/docs/guide/revanced-manager/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "ReVanced Manager",
+    "position": 2,
+    "link": {
+        "type": "generated-index"
+    }
+}