Need to decide on a consistent use of Notes in the curriculum challenges' Description and Instructions sections
See original GitHub issueI have created this issue so we can come to a final conclusion about the best format of notes when they are added to the Description
or Instructions
sections of a challenge file.
Below are all the combinations I have seen scattered throughout the curriculum. There may be others, so please let me know and I will update the list. This only applies if there is a single note. For multiple notes (which in my opinion starts to get unnecessary), see later in this topic.
Example 1:
Note
the note goes here
Example 2:
<strong>Note</strong>
the note goes here
Example 3:
Note:
the note goes here
Example 4:
<strong>Note:</strong>
the note goes here
Example 5:
Note: the note goes here
Example 6:
<strong>Note:</strong> the note goes here
Example 7:
<strong>Note: </strong> the note goes here
Regarding situations where two or more separate notes are added, I have seen:
Example 1:
Notes
* the note goes here
* the note goes here
Example 2:
<strong>Notes</strong>
* the note goes here
* the note goes here
Example 3:
<strong>Notes:</strong>
* the note goes here
* the note goes here
If everyone can cast a vote for their preference of both a single note and multiple notes, this will help us in deciding on one way and then we can update the Styling Guide for challenges in the documentation.
Issue Analytics
- State:
- Created 5 years ago
- Comments:31 (31 by maintainers)
Top GitHub Comments
@rupali317 Also, the note is not the most important thing in the challenge. The actual instruction is. We don’t want to highlight anything that is not relative to the instruction. Most of the time, these notes are FYIs.
I will cast my vote as I prefer Example 7 for single notes, because it takes up less space and adds one additional space between the word
Note:
and the content. I like Example 3 for multiple notes, because I like theNotes
to be bold.