From 2a3395ce1503305da235ca595d3d1b7ee480c1a7 Mon Sep 17 00:00:00 2001 From: validcube Date: Wed, 8 Nov 2023 22:25:33 +0700 Subject: [PATCH] docs: part 9 This commit removes the developer version, preventing this PR from being locked up with additional developer experiences. --- CONTRIBUTING.md | 1 - docs/README.md | 4 ---- docs/developers/0_preparation.md | 26 -------------------------- docs/developers/1_overview.md | 30 ------------------------------ docs/developers/README.md | 14 -------------- 5 files changed, 75 deletions(-) delete mode 100644 docs/developers/0_preparation.md delete mode 100644 docs/developers/1_overview.md delete mode 100644 docs/developers/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33800674..2af7a944 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,6 @@ If you encounter a bug while using the ReVanced Manager app, open an issue using 1. Fork the repository and create a new branch based off the `dev` branch 2. Make sure that the commit name are clear and concise as possible and commit your changes. - If you have never contributed to this repository before, it's recommended to read the overview in the [documentation for developers](/docs/developers/README.md) 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 diff --git a/docs/README.md b/docs/README.md index b3f2a277..f6ae368a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,10 +13,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/ReV 4. [⚙️ Configuring ReVanced Manager](2_4_settings.md) 3. [❔ Troubleshooting](3_troubleshooting.md) -## 👋 Developer version - -Interested in contributing? Consider checking out the developer version of [documentation](/developers/README.md) - ## ⏭️ Start here The next page will tell you about the prerequisites for using ReVanced Manager. diff --git a/docs/developers/0_preparation.md b/docs/developers/0_preparation.md deleted file mode 100644 index f3c5a8ef..00000000 --- a/docs/developers/0_preparation.md +++ /dev/null @@ -1,26 +0,0 @@ -# 💼 Preparing a development environment - -In order to compile ReVanced Manager, certain requirements must be met. - -## 📝 Prerequisites - -* Kotlin IDE such as [Android Studio](https://developer.android.com/studio) -* Knowledge of [Android](https://android.com) app development, and the [Kotlin](https://kotlinlang.org/) language. -* At least JDK 17 of any vendors - -## 🏃 Prepare the environment - -1. Clone the repository - ```sh - git clone https://github.com/ReVanced/revanced-manager.git && cd revanced-manager - ``` -2. Build the application - ```sh - gradlew assembleRelease - ``` - -## ⏭️ What's next - -The next page will introduce you to the basic overview of ReVanced Manager - -Continue: [💁 Overview](1_overview.md) diff --git a/docs/developers/1_overview.md b/docs/developers/1_overview.md deleted file mode 100644 index 5ac0b60c..00000000 --- a/docs/developers/1_overview.md +++ /dev/null @@ -1,30 +0,0 @@ -# 💁 Overview - -Take a quick peak of how ReVanced Compose works. - -## ⚙️ Technology - -We use [Jetpack Compose](https://developer.android.com/jetpack/compose) 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. - -## 📂 Structure - -We structure our code to use [MVVM architecture](https://developer.android.com/topic/libraries/architecture/viewmodel) for easier maintenance of the code. - -## 🧑‍💻 Code readability - -In order to maintain readability of the code, It's highly recommend that you follow -https://developer.android.com/jetpack/compose/api-guidelines style guide to maintain -consistent style through out the codebase. - -## 🎨 Design language - -We adopt the [Material Design 3](https://m3.material.io) as our design language to -bring friendly, intuitive and colourful UI to our application ensuring that the -app's user interface is consistent, customizable, accessible, and engaging for our users. - -## 📃 Commit message - -At ReVanced, we follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) -format for our commit message. diff --git a/docs/developers/README.md b/docs/developers/README.md deleted file mode 100644 index 6cbc0dc6..00000000 --- a/docs/developers/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# 💊 ReVanced Manager - -This documentation explains how [ReVanced Manager](https://github.com/ReVanced/revanced-manager) works. - -## 📖 Table of contents - -0. [💼 Preparing a development environment](0_preparation.md) -1. [💁 Overview](1_overview.md) - -## ⏭️ Start here - -The next page will tell you how to prepare a development environment for ReVanced Manager. - -Continue: [💼 Preparing a development environment](0_preparation.md)