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]: Positions and size of images are looking bad for taking overview of doc. #1281

Open
5 of 6 tasks
Jivanjamadar opened this issue Oct 16, 2024 · 4 comments · Fixed by #1293
Open
5 of 6 tasks

Comments

@Jivanjamadar
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

In readme file in starting of documentation, image positions is not looking good. Images are set vertically so, we have to scroll down for it bit longer for info. It will be bad practices as user or client came to read important info. and if he feels its taking too long so, it will be bad impression on him regarding project.

Suggested Change

Setting images height, width and display in correct manner can fix this issue and as before it taking 5-6 lines it will only take 2 lines to show images.

  1. I will set height, width in proper manner
  2. Will arrange images in inline manner
  3. make doc. more readable

Please kindly assign this issue to me and I will resolve this issue with proficiency

Rationale

Taking technical and general overview of project, client or user always take overview of readme file or documentation of it. If it's more readable and compact it will take less time of user/client and understand the whole project in short.

Urgency

High

Record

  • I have read the Contributing Guidelines
  • I'm a WOB'24(Winter Of Blockchain) contributor
  • I'm a GSSOC'24 Extended contributor
  • I'm a Hacktoberfest'24 contributor
  • I have starred the repository
@Jivanjamadar Jivanjamadar added the enhancement New feature or request label Oct 16, 2024
Copy link
Contributor

Hello @Jivanjamadar Thank you for creating a new issue! 🎉 Your issue is currently under review.
Please wait till the issue is reviewed and assigned.

Copy link
Contributor

Congratulations, @Jivanjamadar! 🎉 Thank you for creating your issue. Your contribution is greatly appreciated and we look forward to working with you to resolve the issue. Keep up the great work!

We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines

@Jivanjamadar
Copy link
Contributor Author

Can you please assign this issue to me so I can resolve this effectively.

@Jivanjamadar
Copy link
Contributor Author

@apu52 Can you please assign this issue to me so I can resolve this effectively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants