Little-Plane-Project icon indicating copy to clipboard operation
Little-Plane-Project copied to clipboard

Documentation rework

Open Glowstick0017 opened this issue 1 year ago • 5 comments

The README of the project was written quite some time ago and the existence of documentation is little to none. That being said, with tools like chatGPT out now and a focus on educating people viewing the project, it would be nice to have some focus on reworking the README and internal documentation so new people viewing the project know what's going on a little bit more.

Some tasks that contributors looking to help on documentation with are as follows:

  • Clean up/reword README, including adding or changing existing sections
  • Add informational, detailed comments and docs to methods in the code so beginners can more easily understand what is happening
  • With the addition of the context menu thanks to jackwebdev, it would be nice to have a detailed instructions page within the application itself including controls and command execution and/or an intro screen before the user starts with information.

Glowstick0017 avatar Oct 04 '23 17:10 Glowstick0017

Hi, @Glowstick0017 , please assign me this issue i want to work on this issue

dipandhali2021 avatar Oct 04 '23 18:10 dipandhali2021

Hello, @Glowstick0017 , I would be grateful if you assign me some parts of this issue if available as there is already one assignee working on it. I would be happy to contribute

prashere avatar Oct 05 '23 12:10 prashere

Can you please assign this issue to me. I want to work on this. Thank you!

Myworld21 avatar Oct 05 '23 18:10 Myworld21

thanks to @danil179 in https://github.com/Glowstick0017/Little-Plane-Project/pull/30, we now have controls for height adjustment. If possible, can I get someone assigned to this issue to add in documentation to the readme and the possible controls/intro dialog of the application. Thank you.

Glowstick0017 avatar Oct 05 '23 19:10 Glowstick0017

Hi @Glowstick0017 if i can get assigned to this I would appreciate it!

Bilal-Shahzad avatar Oct 17 '23 04:10 Bilal-Shahzad

Hello @Glowstick0017 , I am very much experienced in good documentation. You can assign me this task.

khushi505 avatar Oct 12 '24 01:10 khushi505