kentcdodds / react-workshop-app

An abstraction for all my React workshops
https://kentcdodds.com/workshops
MIT License
149 stars 37 forks source link

"edit docs" button next to "Your Notes" is confusing #41

Closed Aprillion closed 3 years ago

Aprillion commented 3 years ago

Problem description:

Each workshop has an "edit docs" button that points to the original Kent's repository, for simplified PR creation if a user will notice a typo or other problem with the exercise MD file.

However, a new section was recently added for "Your Notes" => encouraging users to write their own notes in the MD file inside own git repo:

image

This combination was confusing for me, I thought the Edit button will navigate to the MD file in my editor, e.g. with some version of file:///... (which is blocked by browsers for security reason) or vscode://... (which would need some setup like in https://github.com/shengyou/vscode-handler).

Suggested solutions:

kentcdodds commented 3 years ago

Good point. I prefer your first suggestion. Thanks!

github-actions[bot] commented 3 years ago

:tada: This issue has been resolved in version 4.0.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: