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

Documentation rework #21

Open
Glowstick0017 opened this issue Oct 4, 2023 · 6 comments
Open

Documentation rework #21

Glowstick0017 opened this issue Oct 4, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest-accepted help wanted Extra attention is needed

Comments

@Glowstick0017
Copy link
Owner

Glowstick0017 commented Oct 4, 2023

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 Glowstick0017 added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest-accepted good first issue Good for newcomers labels Oct 4, 2023
@dipandhali2021
Copy link

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

@prashere
Copy link

prashere commented Oct 5, 2023

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

@Myworld21
Copy link

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

@Glowstick0017
Copy link
Owner Author

thanks to @danil179 in #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.

@Bilal-Shahzad
Copy link
Contributor

Bilal-Shahzad commented Oct 17, 2023

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

@khushi505
Copy link

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

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 good first issue Good for newcomers hacktoberfest-accepted help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

6 participants