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

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

docs: Improve documentation #1411

wants to merge 58 commits into from

Conversation

validcube
Copy link
Member

@validcube validcube commented Oct 21, 2023

Guide to use the application will be seperate from this PR

Split

README.md Outdated Show resolved Hide resolved
@validcube validcube marked this pull request as ready for review November 8, 2023 15:31

Co-authored-by: Palm <[email protected]>
@validcube validcube marked this pull request as draft November 8, 2023 15:42
@validcube validcube dismissed PalmDevs’s stale review November 8, 2023 16:43

Staled; also outdated

@validcube validcube mentioned this pull request Nov 11, 2023
@Axelen123
Copy link
Member

What is the status of this?

It might make sense to split out the README and contribution guidelines into a separate PR if the other documentation will take time to finish

@validcube validcube marked this pull request as ready for review December 9, 2023 14:35
@validcube
Copy link
Member Author

validcube commented Dec 9, 2023

Guide to use compose-dev + developer will be seperate from this PR.

This PR will only improve general documentation like README.md and CONTRIBUTING.md, but include changes like spellcheck in other areas.

merge changes from `dev` (flutter)
Comment on lines +7 to 8
<!-- What happen to this? @BenjaminHalko -->
3.
Copy link
Member

Choose a reason for hiding this comment

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

This is still incomplete

@@ -12,7 +12,6 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev
3. [🔄 Updating ReVanced Manager](2_3_updating.md)
Copy link
Member

Choose a reason for hiding this comment

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

Updating has been implemented. The file is out of date (It is also not showing up in the github review page for some reason!)

README.md Outdated

We provide the some of the features are:

* 📱 **Portable**: ReVanced Patcher that fit in your pocket;
Copy link
Member

Choose a reason for hiding this comment

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

This sounds kinda weird. What does "portable" mean here and how is it beneficial?

Copy link
Member Author

Choose a reason for hiding this comment

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

This sounds kinda weird. What does "portable" mean here and how is it beneficial?

I have to generate 4 compelling points or reasons to use the ReVanced Manager 💀

Any suggestion would be great.

Copy link
Member

@oSumAtrIX oSumAtrIX left a comment

Choose a reason for hiding this comment

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

I've seen some consistency errors with our other repositories while skimming through this PR. It would be a good idea first to restore this consistency and then apply the change consistently across all involved repositories. An example of an inconsistency is that other repositories have an "About" section, such as ReVanced CLI, or the merge difference in language and wording.

Apart from that, there are some unfinished sections that already have been commented on as well as the patching page, which features no more note blocks about warnings and pitfalls. It may be a good idea to incorporate them if applicable to restore completeness.

@oSumAtrIX oSumAtrIX changed the title docs: improve documentation docs: Improve documentation Jan 22, 2024
@oSumAtrIX oSumAtrIX marked this pull request as draft January 22, 2024 08:28
@oSumAtrIX oSumAtrIX linked an issue Jul 28, 2024 that may be closed by this pull request
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 6 out of 11 changed files in this pull request and generated 2 suggestions.

Files not reviewed (5)
  • docs/4_building.md: Evaluated as low risk
  • docs/README.md: Evaluated as low risk
  • docs/3_troubleshooting.md: Evaluated as low risk
  • docs/2_1_patching.md: Evaluated as low risk
  • docs/2_2_managing.md: Evaluated as low risk
Comments skipped due to low confidence (2)

docs/0_prerequisites.md:8

  • The phrase 'System that support running at least' is grammatically incorrect. It should be 'Systems that support running at least'.
System that support running at least 'arm64-v8a', 'armeabi-v7a', 'x86_64', or 'x86' application

docs/1_installation.md:3

  • The sentence should be corrected to: 'To use ReVanced on your Android device, ReVanced Manager has to be installed. Refer to the Prerequisites if you haven't already.'
To use ReVanced on your Android device, ReVanced Manager have to be install, refer to the [Prerequisites](0_prerequisites.md) if haven't already.

@@ -1,10 +1,18 @@
# 💼 Prerequisites

In order to use ReVanced Manager, certain requirements must be met.
To use ReVanced Manager, an certain requirements had to be met.
Copy link
Preview

Copilot AI Nov 16, 2024

Choose a reason for hiding this comment

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

The phrase 'an certain requirements had to be met' is grammatically incorrect. It should be 'certain requirements have to be met.'

Suggested change
To use ReVanced Manager, an certain requirements had to be met.
To use ReVanced Manager, certain requirements have to be met.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
### Additional Requirements

> [!NOTE]
> These requirement(s) are not required to be met.
Copy link
Preview

Copilot AI Nov 16, 2024

Choose a reason for hiding this comment

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

The phrase 'These requirement(s) are not required to be met' is awkwardly phrased. It should be 'These requirements are optional.'

Suggested change
> These requirement(s) are not required to be met.
> These requirements are optional.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ReVanced Manager Compose Regarding the Compose rewrite of ReVanced Manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Update the docs to match the latest changes
6 participants