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.

Sign up for GitHub

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

Jump to bottom

docs: Improve documentation #1411

Draft
wants to merge 58 commits into
base: compose-dev
Choose a base branch
from
+234 −105
Draft

docs: Improve documentation #1411

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
58 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
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
85 changes: 85 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<p align="center">
<picture>
<source
width="256px"
media="(prefers-color-scheme: dark)"
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
>
<img
width="256px"
validcube marked this conversation as resolved.
Show resolved Hide resolved
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
<img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
</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">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
</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>
validcube marked this conversation as resolved.
Show resolved Hide resolved
</a>&nbsp;&nbsp;&nbsp;
<a href="https://www.youtube.com/@ReVanced">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
</a>
<br>
<br>
Continuing the legacy of Vanced
</p>

# 👋 Contribution guidelines
Copy link
Member Author

Choose a reason for hiding this comment

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

Should this be "Contribution guidelines" or "ReVanced Manager contribution guidelines"

the second one is consistent with ReVanced Patches repository

https://github.com/ReVanced/revanced-patches/blob/docs/CONTRIBUTING.md#-revanced-patches-contribution-guidelines

Copy link
Member

Choose a reason for hiding this comment

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

I'd say the second one

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
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 probably link to the actual file instead of the table of contents.

* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
validcube marked this conversation as resolved.
Show resolved Hide resolved
* [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).
validcube marked this conversation as resolved.
Show resolved Hide resolved

> [!NOTE]
> We may rejected your request at the discretion of maintainers,
> please provides good motivation for a request to be accepted.
validcube marked this conversation as resolved.
Show resolved Hide resolved

## 🐞 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).
validcube marked this conversation as resolved.
Show resolved Hide resolved

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

Choose a reason for hiding this comment

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

🤔 Doesn't tell me where to discuss the changes...

validcube marked this conversation as resolved.
Show resolved Hide resolved

1. Fork the repository and create your branch from `dev`
validcube marked this conversation as resolved.
Show resolved Hide resolved
2. Make sure that the commit name are clear and concise as possible and commit your changes.
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 what this is supposed to mean.

Copy link
Member Author

Choose a reason for hiding this comment

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

The commit name has to be clear to the maintainer to avoid confusion during development.

We wouldn't want something like refactor: update stuff because it's ambiguous.

Suggested change
2. Make sure that the commit name are clear and concise as possible and commit your changes.
2. Commit your changes and avoid using ambiguous name

If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md)
validcube marked this conversation as resolved.
Show resolved Hide resolved
3. Open a pull request to the `dev` branch and reference issues that your pull request closes
4. The maintainers of ReVanced Manager will review and provide suggestions.
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!

<!-- TODO: Crowdin after release!!! -->

❤️ Thank you for considering contributing to ReVanced Manager
110 changes: 62 additions & 48 deletions README.md
View file
Open in desktop
validcube marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,55 +1,69 @@
# 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-compose/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
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
>
</picture>
<br>
<a href="https://revanced.app/">
<img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
</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">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
</a>&nbsp;&nbsp;&nbsp;
<a href="https://reddit.com/r/revancedapp">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
</a>&nbsp;&nbsp;&nbsp;
<a href="https://t.me/app_revanced">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
</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">
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
</a>
<br>
<br>
Continuing the legacy of Vanced
</p>

# 💊 ReVanced Manager
validcube marked this conversation as resolved.
Show resolved Hide resolved
validcube marked this conversation as resolved.
Show resolved Hide resolved
[![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-compose/commits/compose-dev)

## ❓ About
ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications

## 💪 Features
We provide the some of the features are:
* 📱 ReVanced Patcher that fit in your pocket!
* 🤗 Friendly & initutive UI to help you manage your patched applications!
* 🛠️ Lot's of customisation to 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)
validcube marked this conversation as resolved.
Show resolved Hide resolved

## 📝 Prerequisites
## 📄 Documentation
Step on how to compile & use the application are available [here](/docs/README.md).

For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md)
## 👋 Contributing
You can find the contribution guidelines [here](/CONTRIBUTING.md), Thanks for consider contributing to ReVanced Manager!

## 🔴 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)
For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/new/choose) with ReVanced Manager Compose label.
Loading