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 Update]: README.md #396

Closed
4 tasks done
purnima2904 opened this issue Oct 9, 2024 · 2 comments · Fixed by #404
Closed
4 tasks done

📝[documentation Update]: README.md #396

purnima2904 opened this issue Oct 9, 2024 · 2 comments · Fixed by #404
Labels
documentation Improvements or additions to documentation enhancement New feature or request gssoc-ext hacktoberfest-accepted

Comments

@purnima2904
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

No content in featured in section
No website preview available
No About section
No table of contents
Screenshot 2024-10-09 222601
Screenshot 2024-10-09 222609

Suggested Change

Add a table of content for contributors to easily navigate throughout the readme file
Create a more descriptive about section which gives detailed outline of the website
Insert content in featured in section
Provide a website preview through screenshots and a direct link to the website below it.
Add code of conduct and contribution section directly linking to the actual file.
Make use of Repobeats analytics to visualize the repository activities.

Rationale

Making these changes will make the readme file more engaging and interactive.
This will provide a better understanding about the project.

Urgency

High

Record

  • I have read the Contributing Guidelines
  • I'm a GSSOC'24EXTD contributor
  • I have starred the repository
Copy link

github-actions bot commented Oct 9, 2024

Hi there! Thanks for opening this issue @purnima2904!. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

@github-actions github-actions bot added gssoc-ext hacktoberfest-accepted documentation Improvements or additions to documentation enhancement New feature or request labels Oct 9, 2024
@purnima2904
Copy link
Contributor Author

assign me this issue

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 enhancement New feature or request gssoc-ext hacktoberfest-accepted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant