From fd27725699f67d010d40fe2ff616d0992d465522 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 23 Feb 2024 02:30:59 +0100 Subject: [PATCH] docs: Remove documentation section The documentation for patches is being moved to the ReVanced Patcher repository. The reason for this is because the documentation about how to create patches using ReVanced Patcher, belongs in the ReVanced Patcher repository, whereas documentation specific to the public API of ReVanced Patches belongs in this repository. Because the public API has no documentation yet, the section is removed until then. --- CONTRIBUTING.md | 6 +++--- README.md | 5 ----- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4239b41..9ee86457 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,8 +64,8 @@ This document describes how to contribute to ReVanced Patches. ## 📖 Resources to help you get started -* The [documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) provides the fundamentals of patches -and everything necessary to create your own patch from scratch +* The [documentation](https://github.com/ReVanced/revanced-patcher/tree/docs) contains the fundamentals +of ReVanced Patcher and how to use ReVanced Patcher to create patches * [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-patches/issues) are where we keep track of bugs and feature requests @@ -110,7 +110,7 @@ are unaffected by this change. ## 📝 How to contribute -1. Before contributing, it is recommended to open an issue to discuss your change +1. Before contributing, it is recommended to open an issue to discuss your change with the maintainers of ReVanced Patches. This will help you determine whether your change is acceptable and whether it is worth your time to implement it 2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev` diff --git a/README.md b/README.md index 1934a09f..bae60036 100644 --- a/README.md +++ b/README.md @@ -93,11 +93,6 @@ You can use [ReVanced CLI](https://github.com/ReVanced/revanced-cli) or [ReVance Thank you for considering contributing to ReVanced Patches. You can find the contribution guidelines [here](CONTRIBUTING.md). -### 📃 Documentation - -The documentation provides the fundamentals of patches and everything necessary to create your own patch from scratch. -You can find it [here](https://github.com/ReVanced/revanced-patches/tree/docs/docs). - ### 🛠️ Building In order to build ReVanced Patches, you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).