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

Enhance README.md with Links to Guides #1

Open
ToobaJamal opened this issue Sep 25, 2023 · 1 comment
Open

Enhance README.md with Links to Guides #1

ToobaJamal opened this issue Sep 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ToobaJamal
Copy link

I noticed that the current README.md of this repository contains a general idea of the repository's purpose but could be more informative and user-friendly.

I suggest that we improve the README.md by adding direct links to the relevant guides within the repository along with brief descriptions of each guide as README.md is typically the first point of contact for users.

If you agree, I would be happy to contribute to this improvement by submitting a pull request with the necessary changes. Let me know your thoughts on this proposal.

Thank you for considering this suggestion, and I look forward to your response.
@mafen
Copy link
Member

mafen commented Sep 25, 2023

Thank you for suggesting improvements to the README.md and the project in general.

@mafen mafen added the documentation Improvements or additions to documentation label Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mafen @ToobaJamal