question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Need to decide on a consistent use of Notes in the curriculum challenges' Description and Instructions sections

See original GitHub issue

I 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:&nbsp;</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:closed
  • Created 5 years ago
  • Comments:31 (31 by maintainers)

github_iconTop GitHub Comments

3reactions
RandellDawsoncommented, Mar 1, 2019

@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.

2reactions
RandellDawsoncommented, Feb 28, 2019

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 the Notes to be bold.

Read more comments on GitHub >

github_iconTop Results From Across the Web

5.6 Note-Taking – Student Success - BC Open Textbooks
Taking notes helps you to focus your attention and avoid distractions. As you take notes in class, you will be engaging your mind...
Read more >
Chapter:7. Designing Curriculum, Instruction, Assessment ...
Read chapter 7. Designing Curriculum, Instruction, Assessment, and Professional Development: This book takes a fresh look at programs for advanced studies.
Read more >
Page 16: Lesson Plan Design - IRIS Center
The daily lesson plan is the most detailed standards-based plan that a teacher will develop. It outlines the purpose and activities of what...
Read more >
5E Model of Instruction - ngss sdcoe
“The 5E Model of Instruction includes five phases: Engage, Explore, Explain, Elaborate, and Evaluate. It provides a carefully planned sequence of ...
Read more >
Integrated Curriculum in the Primary Program
Integrated teaching and learning processes enable children to acquire and use basic skills in all the content areas and to develop positive attitudes...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found