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

chore updated the readme.md file with a more clearer explaination and better visual representation #816

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Musharraffaijaz
Copy link
Contributor

Some of the preview of the the updated READme.md

Screenshot From 2025-01-05 12-14-33
Screenshot From 2025-01-05 12-16-16

Copy link

netlify bot commented Jan 5, 2025

Deploy Preview for numpy-org ready!

Name Link
🔨 Latest commit 48e62aa
🔍 Latest deploy log https://app.netlify.com/sites/numpy-org/deploys/677a78873f741a00086c300d
😎 Deploy Preview https://deploy-preview-816--numpy-org.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.

@Musharraffaijaz
Copy link
Contributor Author

Hi, @steppi and @stefanv @jarrodmillman I've opened this PR to address the readme clarity. Kindly review it and let me know if any changes are required!

@stefanv
Copy link
Contributor

stefanv commented Jan 17, 2025

@Musharraffaijaz I don't want to be discouraging, but I think these changes go in the wrong direction. We like instructions to be crisp, concise, and clear. These changes add a lot of background information that most developers on the project are already familiar with, which means the signal to noise ratio goes down, making it harder to gather the important information we mean to share.

I think, if you want to make improvements to the README, you'd have to:

  1. Identify a specific issue
  2. Discuss the issue with us, to figure out how it should be addressed
  3. Make a very minimal PR to address just that one change

@Musharraffaijaz
Copy link
Contributor Author

Quote reply
Reference in

Thank you for your reply, will keep these things in mind. In my view, the visual representation of the current documentation was a bit old, that's why thought of updating it. But after your suggestions I beleive for a beginner the installation and starting of the dev server is a bit confusing either on windows or Linux, so will update that shortly.

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

Successfully merging this pull request may close these issues.

2 participants