Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve documentation #1411

Open
wants to merge 92 commits into
base: compose-dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 90 commits
Commits
Show all changes
92 commits
Select commit Hold shift + click to select a range
e7b9486
docs: merge branding to readme (SEE TODO)
validcube Oct 8, 2023
676eb1e
docs: part 2
validcube Oct 9, 2023
67603f6
docs: part 2.1
validcube Oct 21, 2023
85c6e72
docs: add ReVanced assets
validcube Oct 21, 2023
26b9652
docs: part 3
validcube Oct 21, 2023
830a666
docs: part 4
validcube Oct 21, 2023
949b1da
docs: part 4.1
validcube Oct 21, 2023
e0dfbaf
docs: part 4.2
validcube Oct 21, 2023
9b9525e
docs: part 4.3
validcube Oct 21, 2023
f732df1
docs: part 4.4
validcube Oct 21, 2023
a503f48
docs: part 4.5
validcube Oct 21, 2023
a280fc2
docs: part 4.5.1 (test)
validcube Oct 21, 2023
cd5787a
docs: part 4.6
validcube Oct 21, 2023
2f0cdff
docs: part 4.7
validcube Oct 21, 2023
b8378fb
docs: part 4.8
validcube Oct 21, 2023
259f763
docs: part 4.9
validcube Oct 21, 2023
d58fd96
docs: part 4.10
validcube Oct 21, 2023
8a3d163
docs: part 5
validcube Oct 21, 2023
7bf1a5a
docs: part 5.1
validcube Oct 21, 2023
3c083ed
docs: part 5.2
validcube Oct 21, 2023
2f782b4
docs: part 6
validcube Oct 21, 2023
98747f4
docs: part 6.1
validcube Oct 21, 2023
1f5331d
docs: part 6.2
validcube Oct 21, 2023
8acdc17
docs: part 6.3
validcube Oct 21, 2023
0d2d879
docs 6.4
validcube Oct 21, 2023
a70ad3d
docs: part 6.5
validcube Oct 21, 2023
1877408
docs: part 6.6
validcube Oct 21, 2023
7b49af2
docs: part 6.7
validcube Oct 21, 2023
cf9a14c
docs: part 6.8
validcube Oct 21, 2023
d06fb08
docs: part 6.9
validcube Oct 21, 2023
f14b697
docs: part 7
validcube Oct 21, 2023
a3c48d1
docs: part 7.1
validcube Oct 21, 2023
07ee005
docs: part 8
validcube Oct 22, 2023
891fb57
docs: part 8.1
validcube Oct 22, 2023
10815c8
docs: part 7.2
validcube Oct 22, 2023
a8682d6
docs: part 8.3
validcube Oct 22, 2023
af49457
docs: part 8.4-1
validcube Oct 22, 2023
94eb893
docs: 8.4-1.1
validcube Oct 22, 2023
dcf51c1
docs: part 8.4-2
validcube Oct 22, 2023
2f31fc7
docs: part 8.5
validcube Oct 23, 2023
0419b2f
docs: part 8.6
validcube Oct 23, 2023
bc09af9
docs: part 8.6.1 (test)
validcube Oct 23, 2023
944b57c
docs: part 8.7
validcube Nov 8, 2023
2a3395c
docs: part 9
validcube Nov 8, 2023
d32a213
docs: part 9.1
validcube Nov 8, 2023
35996b6
docs: part 9.2
validcube Nov 8, 2023
1521d21
docs: part 9.3
validcube Nov 8, 2023
62bb0d3
docs(accessibility): part 9.4
validcube Nov 8, 2023
3c56db4
Merge branch 'compose-dev' into docs/readme
validcube Dec 9, 2023
94de170
docs: part 9.5
validcube Dec 9, 2023
ace6701
🔮 Merge repository updated to latest snapshot!
validcube Aug 18, 2024
adf5f9f
docs: Pull change from ReVanced Branding
validcube Aug 18, 2024
a290369
docs: Pull change from ReVanced Manager Flutter
validcube Aug 18, 2024
db4ce6b
docs: Use correct asset directory
validcube Aug 18, 2024
3bbad15
part: 10 (1/?)
validcube Aug 18, 2024
05bf940
nitpicking on style
validcube Aug 18, 2024
8442bf2
🔮 Merge repository updated to latest snapshot!
validcube Oct 1, 2024
911201a
Signed off to switch branch
validcube Oct 17, 2024
5125084
docs: Merge valid suggestions from Copilot review
validcube Nov 24, 2024
50c46dc
docs(readme): Merge building to contributing section
validcube Nov 24, 2024
d987845
docs: Actually link to documentation
validcube Nov 24, 2024
177b716
🔮 Merge repository updated to latest snapshot!
validcube Jan 19, 2025
4364f2e
Standardised download site
validcube Jan 19, 2025
04a2a78
Change wording to remove redundancy
validcube Jan 19, 2025
b0624a3
OOM error troubleshooting
validcube Jan 19, 2025
91e06cb
OOM error troubleshooting
validcube Jan 19, 2025
03c9168
Split to section
validcube Jan 19, 2025
6dfb2a2
Try or report
validcube Jan 19, 2025
44fc455
Add settings location
validcube Jan 19, 2025
2616576
grammartical corerct
validcube Jan 19, 2025
bec0d82
grammartical corerct
validcube Jan 19, 2025
5b790a8
Comfortable docs viewing
validcube Jan 19, 2025
6598db5
Update Manager guide!!
validcube Jan 27, 2025
617481f
End of section
validcube Jan 27, 2025
d1ef14a
format
validcube Jan 27, 2025
802330c
Verification step
validcube Jan 27, 2025
1c6a9db
Developer - Transparency
validcube Jan 27, 2025
a53a0bd
Comfortable docs edit viewing
validcube Jan 27, 2025
8f9ea54
Update ref
validcube Jan 27, 2025
db304a7
Merge suggestions from Copilot
validcube Jan 27, 2025
d3748cf
Easily distinguishness
validcube Jan 27, 2025
91f6672
Add linkj
validcube Jan 27, 2025
5993dc3
Add manage app
validcube Jan 27, 2025
046179d
Remove copy-pasta
validcube Jan 27, 2025
351e00c
format
validcube Jan 27, 2025
d47819c
Update docs/developer/3_verifying.md
validcube Jan 28, 2025
15cfeb6
Update docs/0_prerequisites.md
validcube Jan 29, 2025
0eee869
Update docs/2_4_settings.md
validcube Jan 29, 2025
b9401b5
Update docs/3_troubleshooting.md
validcube Jan 29, 2025
c2a942b
Update docs/2_4_settings.md
validcube Jan 29, 2025
8731e72
Fix grammar in GitHub Registry section
validcube Feb 19, 2025
a5d09b2
Consolidate optional root device requirements in docs
validcube Feb 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<p align="center">
<picture>
<source
width="256px"
media="(prefers-color-scheme: dark)"
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
>
<img
width="256px"
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://github.com/ReVanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="http://revanced.app/discord">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://x.com/revancedapp">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://www.youtube.com/@ReVanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
</picture>
</a>
<br>
<br>
Continuing the legacy of Vanced
</p>

# 👋 Contribution guidelines

Welcome to contribution guidelines, this document contains
everything you'll need to contribute to ReVanced Manager (and might even possibly apply to our other project like ReVanced Patches!)

There are many ways to contribute like writing docs and code, opening issues,
helping people out in our community, translating or sponsoring our project, etc.

## 📖 Resources to help you get started

* The [documentation](/docs/developer/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
* [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).

> [!NOTE]
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager.
> Good motivation has to be provided 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).

## 🌐 Submitting translations

You can contribute translations at translate.revanced.app

> [!TIP]
> * Try to keep the translated text roughly the same length as the original.
> * Consider opting for gender-neutral words for language with variations of words based on gender.

## 🧑‍💻 Developing for ReVanced Manager

See the guidelines for developing for ReVanced Manager [here](/docs/developer/README.md)

## 🔒 Submitting a vulnerability

See the guideline for reporting security vulnerability [here](/SECURITY.md)

## 🤚 I don't want to do any of that but I want to contribute either way

You can still contribute by spreading positive word about us or if you'd like to sponsor us, checkout https://revanced.app/donate
to learn more about how you can sponsor via GitHub, Open Collective, and cryptocurrencies.

❤️ Thank you for considering contributing to ReVanced Manager,
ReVanced
135 changes: 92 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,104 @@
# ReVanced Manager (Compose Rewrite)

[![GitHub license](https://img.shields.io/github/license/revanced/revanced-manager)](../../blob/main/LICENSE)
[![GitHub last commit](https://img.shields.io/github/last-commit/revanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/revanced/revanced-manager/compose-dev)](https://github.com/ReVanced/revanced-manager/commits/compose-dev)

_(Yet another)_ rewrite of the ReVanced Manager using Kotlin and Jetpack Compose.

## Design system

In this rewrite, we are adopting the latest Material Design principles and guidelines by using Material 3 and Material You.

Material Design is a design system developed by Google that provides a unified visual language for building beautiful and consistent user interfaces across all platforms and devices. Material You is an extension of Material Design that provides even more customization options for users, making it possible for them to personalize their device and create a unique look and feel.

### Why Material 3?

* **Consistent design language**
* **Improved accessibility**
* **Better user experience**

By using Material 3 and Material You, we are ensuring that the app's user interface is consistent, customizable, accessible, and engaging for our users. This will help to improve the overall user experience and increase user satisfaction with the the manager.

## Technology stack

* Kotlin: Kotlin is a modern and concise programming language that is fully interoperable with Java and provides improved safety, readability, and maintainability compared to Java.
* Jetpack Compose: Jetpack Compose is a modern UI toolkit for Android development that allows developers to 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.

## Why Kotlin and Compose?

* **Improved safety:** Kotlin provides improved safety compared to Java, which reduces the likelihood of common programming mistakes that can cause security vulnerabilities or crashes.
* **Concise and readable code:** Kotlin's concise syntax and expressive type system make the code more readable, which makes it easier for developers to understand and maintain the codebase.
* **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.
<p align="center">
<picture>
<source
width="256px"
media="(prefers-color-scheme: dark)"
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
>
<img
width="256px"
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://github.com/ReVanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="http://revanced.app/discord">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://x.com/revancedapp">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
</picture>
</a>&nbsp;&nbsp;&nbsp;
<a href="https://www.youtube.com/@ReVanced">
<picture>
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
</picture>
</a>
<br>
<br>
Continuing the legacy of Vanced
</p>

# 💊 ReVanced Manager

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-manager/release.yml)](https://github.com/ReVanced/revanced-manager/actions/workflows/release.yml)
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](#️-license)

Application to use ReVanced on Android

## ❓ About

ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.

## 💪 Features

Some of the features ReVanced Manager provides are:

- 💉 **Patch apps**: Apply any patch of your choice to Android apps
- 📱 **Portable**: ReVanced Patcher that fits in your pocket
- 🤗 **Simple UI**: Quickly understand the ins and outs of ReVanced Manager
- 🛠️ **Customization**: Configurable API, custom sources, language, signing keystore, theme and 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 get the most recent version of ReVanced Manager by downloading from
the [ReVanced site](https://revanced.app/download).

## 📝 Prerequisites
Learn how to use ReVanced Manager by following the [documentation](/docs).

For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md)
## 📚 Everything else

## 🔴 Issues
### 📙 Contributing

For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose).
Thank you for considering contributing to ReVanced Manager.

## 🌐 Translation
The [contribution guidelines](CONTRIBUTING.md) provides information you'll need to open an issue, develop for ReVanced Manager and translations.

[![Crowdin](https://badges.crowdin.net/revanced/localized.svg)](https://crowdin.com/project/revanced)
### 📄 Documentation

We're accepting translations on [Crowdin](https://translate.revanced.app)
You can find the documentation for ReVanced Manager [here](/docs).

## 🛠️ Building Manager from source
## ⚖️ License

For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md)
ReVanced Manager is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Manager as long as you track changes/dates in source files.
Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions.
20 changes: 13 additions & 7 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,20 @@ This document describes how to report security vulnerabilities for ReVanced Mana

## 🚨 Reporting a Vulnerability

Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new) or reach out privately to us on [Discord](https://discord.gg/revanced).
Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new)
or reach out privately to us on [Discord](https://discord.gg/revanced).

If a vulnerability is confirmed and accepted, you can join our [Discord](https://discord.gg/revanced) server to receive a special contributor role.
If a vulnerability is confirmed and accepted, they will be published and
you can join our [Discord](https://discord.gg/revanced) server to receive a
special contributor role.

### ⏳ Supported Versions

| Version | Branch | Supported |
| --------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------ |
| ![Latest stable release](https://img.shields.io/github/v/release/ReVanced/revanced-manager?style=for-the-badge "Latest stable release") | main | :white_check_mark: |
| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | dev | :white_check_mark: |
| ![Latest version](https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version") | compose-dev | :white_check_mark: |
| Version | Branch | Supported |
|------------------------------------------|---------------|--------------------|
| ![Latest stable release][LatestRelBadge] | `main` | :white_check_mark: |
| ![Latest version][LatestVerBadge] | `dev` | :white_check_mark: |
| ![Latest version][LatestVerBadge] | `compose-dev` | :white_check_mark: |

[LatestRelBadge]: https://img.shields.io/github/v/release/ReVanced/revanced-manager?style=for-the-badge "Latest stable release"
[LatestVerBadge]: https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version"
8 changes: 6 additions & 2 deletions docs/0_prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# 💼 Prerequisites

In order to use ReVanced Manager, certain requirements must be met.
To use ReVanced Manager, certain requirements have to be met.

## 🤝 Requirements

- An Android device running Android 8 or higher
- Android device running Android 8.0 or higher

### Optional Requirements

- Rooted Android device with latest version of [KernelSU](https://github.com/tiann/KernelSU) or [Magisk](https://github.com/topjohnwu/Magisk)

## ⏭️ What's next

Expand Down
18 changes: 15 additions & 3 deletions docs/1_installation.md
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## Installation steps
## 🪜 Installation steps

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].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording in the main branch is better than here.

2. Install ReVanced Manager

### ✒️ Verifying authenticity of ReVanced Manager
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


> [!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*.

Comment on lines +11 to +19
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem like enough information for a user to successfully verify an APK.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the official Android docs to verify the APK should be referenced and/or the official documented method should be mentioned here.

## ⏭️ What's next

The next page will guide you through using ReVanced Manager.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wording in main branch is better than here.


Continue: [🛠️ Usage](2_usage.md)

[Official ReVanced Download]: https://revanced.app/download
22 changes: 16 additions & 6 deletions docs/2_1_patching.md
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May have to be rewritten for Compose version

Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 1 should be removed.

3. Choose an app to patch[^1]
4. Tap on the version of the app you want to patch[^2]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to select from storage unless you have downloader plugins installed, which is not mentioned here.

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.
5. Tap the 🪄 **Patch** button
6. Tap on the 📲 **Install** button
> [!Note]
> If the **Install** Button isn't there, it could be that something went wrong. Refer to [3. ❔ Troubleshooting](3_troubleshooting.md)
> [!Tip]
Comment on lines +13 to +15
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem to render correctly
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nested note blocks don't render unfortunately. See how the main branch solves this.

> 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 bottom left 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.
[^1]: You need 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.

### Change patch selection and options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once again, this should not be a separate section, follow how the main branch does it.


Before you can change the selection of patches, follow the step below to allow changing the selection of patches.

1. Tap ⚙️ Settings button in the top right corner
2. Go to Advanced Settings
3. Toggle "Allow changing patch selection" on
Comment on lines +23 to +29
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this section is necessary. This is explained inside the app and changing selection is not recommended.


## ⏭️ What's next

The next page will bring you back to the usage page.
Expand Down
Loading