ssitvit / Code-Canvas

A hub for innovation through web development projects
https://codecanvas.ieeessitvit.com/
MIT License
80 stars 127 forks source link

[docs] Improve clarity and user experience in README.md #436

Closed jfmartinz closed 1 year ago

jfmartinz commented 1 year ago

Closes #410

Description

  1. Renamed Contributors.md to Contributing.md: The original description stated that the documentation was intended for contribution guidelines, but it mistakenly directed contributors to the wrong file (Contributors.md). To resolve this, I changed it to Contributing.md, which accurately represents the file's purpose and guides contributors on how to contribute to the project.

  2. Added a hyperlink to Contributors.md: In order to streamline the process for contributors, I included a clickable link to the Contributors.md file. This eliminates the need for contributors to search for the mentioned Contributors.md file separately, allowing them to directly access the relevant documentation with just one click.

These changes significantly enhance the user experience and improve the clarity of the documentation, ensuring that contributors can easily find the correct information and guidelines for their contributions.

Screenshots

Before: image

After: image

Checklist

netlify[bot] commented 1 year ago

Deploy Preview for joyful-otter-a57da4 ready!

Name Link
Latest commit 94bc5edd6f704c927d89ecebfeae416b66e2a795
Latest deploy log https://app.netlify.com/sites/joyful-otter-a57da4/deploys/649e8ee483f4d30008188ea7
Deploy Preview https://deploy-preview-436--joyful-otter-a57da4.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jfmartinz commented 1 year ago

btw @Dharmesh177 im a gssoc contributor. thank you!