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 CONTRIBUTING.md link to directly redirect to the relevant README section #776

Open
YashPimple opened this issue May 16, 2024 · 0 comments
Labels
infrastructure Issues related to the docs HTML, CSS, JS or hosting

Comments

@YashPimple
Copy link

What problem did you find?

So when we go through the Contributing Guideline page we often see if we click on CONTRIBUTING.md it tend to redirect us to contributing/ which is not convenient for new contributors like me.

Proposed Solution

To enhance user experience we can redirect users whenever they click on CONTRIBUTING.md to the required README file. This change would eliminate unnecessary clicks, making it more convenient for users to find the information they need rather than going from Click the CONTRIBUTING.md -> then again clicking on to contributing/ -> and then landing to the required README file

we can improve the structured documentation by adding appropriate links to the required section.

@YashPimple YashPimple added the infrastructure Issues related to the docs HTML, CSS, JS or hosting label May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Issues related to the docs HTML, CSS, JS or hosting
Projects
None yet
Development

No branches or pull requests

1 participant