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(readme/contributing/wiki): streamline documentation #353

Open
3 tasks done
AnonymousWP opened this issue Mar 17, 2024 · 2 comments
Open
3 tasks done

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

AnonymousWP opened this issue Mar 17, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@AnonymousWP
Copy link
Member

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

  • This issue is not a duplicate of an existing documentation change request.
  • I have chosen an appropriate title.
  • All requested information has been provided properly.
@AnonymousWP AnonymousWP added the documentation Improvements or additions to documentation label Mar 17, 2024
@AnonymousWP AnonymousWP self-assigned this Mar 17, 2024
@edgy-b
Copy link
Contributor

edgy-b commented Mar 18, 2024

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

Quick startup

  • install adb
  • use the application

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

  • 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.

image

  • or make getting started actual link to getting started page in wiki

image

@AnonymousWP
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants