crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
47 stars 105 forks source link

update CONTRIBUTING.md link to directly redirect to the relevant README section #776

Open YashPimple opened 2 months ago

YashPimple commented 2 months ago

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.