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.

Sign up for GitHub

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

Jump to bottom

Documentation improvement #3

Open
Animeshz opened this issue Oct 2, 2023 · 2 comments
Open

Documentation improvement #3

Animeshz opened this issue Oct 2, 2023 · 2 comments
Labels
good first issue Good for newcomers hacktoberfest

Comments

@Animeshz
Copy link
Owner

Animeshz commented Oct 2, 2023 •
edited
Loading

Review the existing documentation and identify areas (README or script's comments) for improvement.

Any of these are accepted:

  • Adding usage examples with clear explanations for each script.
  • Improving the documentation, making sure its clear and easy to follow.
  • Improving the getting started section (if can be made more simpler: maybe use more english than shell commands).
  • Any incorrectness found can be fixed.
@Durgeshsejekar
Copy link

I want to work on this issue so please can you assign me

@Animeshz
Copy link
Owner Author

Animeshz commented Oct 2, 2023

Sure, you can start working on this...

General issues like these don't need assignment, as you (or anybody else) can always make more improvements as necessary.

@Animeshz Animeshz added the good first issue Good for newcomers label Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Animeshz @Durgeshsejekar