Universal-Debloater-Alliance / universal-android-debloater-next-generation

Cross-platform GUI written in Rust using ADB to debloat non-rooted Android devices. Improve your privacy, the security and battery life of your device.
GNU General Public License v3.0
2.41k stars 83 forks source link

docs(readme/contributing/wiki): streamline documentation #353

Open AnonymousWP opened 7 months ago

AnonymousWP commented 7 months ago

Describe the documentation you want to change

At the moment, our documentation is quite split. For example, we want to keep the README minimal and should serve as a summary for this repository, like how it should be. However, we also have a CONTRIBUTING.md file and a Wiki. We need to draw a line, for instance:

Acknowledgements

edgy-b commented 7 months ago

There is aboslutely no need to rewrite wiki. We can add section

Quick startup

As of now on wiki homepage at the bottom there is link Getting started and section image

Rarely user will get to this page in my view

image

image

AnonymousWP commented 7 months ago

Thanks for your input.

But I do not want to put a quick start in the README, as it's then hard to draw a line, sort of. The "Getting started" page is at the bottom, and I can't fix that, unless I customise the pages which take a bit of work.

maybe change wording For documentation. I believe in users eyes documentation is for dev's, gone is the age of terminal where user inserts floppy disc and really has to read documentation how to use software.

This I can understand. I have fixed that a short while ago, what do you think? Would it be more clear now? Because the README is short, users would easily see the Documentation header and thus how to get started.