-
Notifications
You must be signed in to change notification settings - Fork 106
Open
Labels
readyfor VIfor VI
Description
Problem
Some instructions in Step 3 are unclear or contain overwhelming amounts of information, which would deter new interns.
- "Preparation" is unclear in what one is supposed to do, but this might be caused by issue switch color scheme to white on black #2 (having several pages of links and thousands of words).
- Unlike the Markdown and MDwiki links, the GitHub link is extremely verbose, with several pages of links and thousands of words, and it's unclear which sections the intended reading is supposed to include, when the reading is supposed to stop, or what sections should be skimmed. It's also not clear that this is for reading only.
- 5 resources for learning Markdown syntax can cause decision paralysis, and some prospective interns may waste time doing all of them 'just in case' despite the note.
Steps to reproduce the problem
N/A
Screenshots
Proposed solution
- Delete
Preparation
, AND addReadings
- Replace GitHub's hyperlink with a link to a more concise summary/reading for GitHub, much like the ones for Markdown and MDwiki. I'm not sure what the original intended learning for this link was supposed to be, and I am not experienced enough with GitHub to recommend resources.
- Move the top 3 resources down at the bottom, AND create a new section of these Markdown resources called
Additional Resources for Markdown
, explaining that these are optional resources that the user might find useful. I left the other 2 resources because they are interactive (active learning promotes long-term learning, especially for syntax).
Metadata
Metadata
Assignees
Labels
readyfor VIfor VI