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

Enhance Readability of Documentation by Adding Emojis and Headings #358

Open
1 task done
NishantRana07 opened this issue Oct 13, 2024 · 3 comments
Open
1 task done
Labels
type: feature-request New feature or request

Comments

@NishantRana07
Copy link

🔖 Feature description

A visually appealing and structured documentation can help users and contributors find relevant information faster.

🎤 Why is this feature needed ?

Currently, the documentation files (such as README.md, SECURITY.md, etc.) lack visual elements and structured headings that can improve readability and user experience.

✌️ How do you aim to achieve this?

assign it to me under hacktoberfest label

🔄️ Additional Information

No response

👀 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

Are you willing to submit PR?

Yes I am willing to submit a PR!

@NishantRana07 NishantRana07 added the type: feature-request New feature or request label Oct 13, 2024
@jamesread
Copy link
Collaborator

Okay, please try this with just one page and we'll review. I have to say adding emoji sounds annoying to me, I'm more interested in what headings you think are missing.

@NishantRana07
Copy link
Author

Sure sir

@NishantRana07
Copy link
Author

these are the possible headings that can be added to the README.md

  • Installation
  • Usage
  • API Reference
  • Contributing
  • Roadmap
  • Support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants