feiphoon/github-workshop

Instructions (both initial waypoints and exercise intro) in main README were missed

feiphoon opened this issue ยท 0 comments

Describe the bug
Enough(? for me to raise this? ๐Ÿ˜†) attendees may not have noticed the waypoints and one group managed to power through without knowing they had to click on the titles to see the full instructions and screenshots (I'm genuinely impressed! But apologetic that it happened).

To Reproduce
Steps to reproduce the behavior:

  • Go to the main README.md read the start of the main thing, and Exercises.

Expected behavior

  • Visitors should notice and use the waypoints at the start of the file.
  • Students should notice and understand the tip to click on the section titles to view more instructions and screenshots .

Suggested solutions

  • Bullet-point the waypoints
  • Turn the workshop breakdown section into a Table of Contents
  • Format the workshop items into a tabular form
  • Use iconography (well, emoji, e.g. ๐Ÿ”—) for visual reinforcement
  • Bold important bits (last resort and should be used sparingly)