Link to mentoring roles from main README.md is broken

carpentries / instructor-development

resources collected by the mentoring committee for instructors

13 stars 20 forks source link

Closed mkuzak closed 7 years ago

mkuzak commented 7 years ago

From the main readme:

For a complete summary of different mentoring roles, see [this page](roles.md)

We can either:

choose to link to the the directory [this page](roles)
create a roles.md and link to it [this page](roles.md)
create a README.md in roles dir and link to the readme [this page](README.md) I'm in favour of the last one. It provides structure and is visible is someone wanders into this directory, thanks to GitHub rendering.

mkuzak commented 7 years ago

I just realised that there is a roles page in the root of the repository membership-roles.md. Maybe we should link to that one.

ChristinaLK commented 7 years ago

I think it's up to you.

mkuzak commented 7 years ago

We can keep both, the README is just a TOC for roles. Something to see when you visit the repository. There is a pull request for it already.