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

Update README for Improved Documentation #75

Closed
jinx-vi-0 opened this issue May 12, 2024 · 8 comments
Closed

Update README for Improved Documentation #75

jinx-vi-0 opened this issue May 12, 2024 · 8 comments
Assignees
Labels
gssoc Under GirlScript Summer of code GSSoC'24 Under GirlScript Summer of code level2 medium

Comments

@jinx-vi-0
Copy link
Contributor

Clear and well-structured documentation is crucial for users and contributors to understand the project, its purpose, and how to get started. The current README is not visually appealing and also lacks some begineer friendly contribution start guide.

hey @MAVRICK-1 , please assign this issue to me.

@MAVRICK-1
Copy link
Owner

@jinx-vi-0 we got learn.md for that

@jinx-vi-0
Copy link
Contributor Author

@MAVRICK-1 , so I can make README more visually appealing by adding badges for tech stack and other proper formatting of the README.

@MAVRICK-1
Copy link
Owner

@jinx-vi-0 okay go ahead

@MAVRICK-1 MAVRICK-1 added GSSoC'24 Under GirlScript Summer of code level2 medium gssoc Under GirlScript Summer of code labels May 12, 2024
@MAVRICK-1
Copy link
Owner

@jinx-vi-0 i am giving level 2 for now , if i like your work it will be upgraded to level 3

@MAVRICK-1 MAVRICK-1 assigned jinx-vi-0 and unassigned Jiggy9 May 12, 2024
@jinx-vi-0
Copy link
Contributor Author

ok will sure impress you

@MAVRICK-1
Copy link
Owner

@jinx-vi-0 can you fix issue with contributors section in Readme.md it is not show images of all the contributors

@jinx-vi-0
Copy link
Contributor Author

@MAVRICK-1 ya sure.

@jinx-vi-0 jinx-vi-0 mentioned this issue May 13, 2024
6 tasks
@jinx-vi-0
Copy link
Contributor Author

@jinx-vi-0 can you fix issue with contributors section in Readme.md it is not show images of all the contributors

I've looked into the issue with the contributors section. It appears that not all contributors' images are being displayed here, although they are visible on the website. After some investigation, I've discovered that this is a known issue with the website. It caches the initial request, causing subsequent requests to be queued. The display should auto-update later to include all contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc Under GirlScript Summer of code GSSoC'24 Under GirlScript Summer of code level2 medium
Projects
None yet
Development

No branches or pull requests

3 participants