WEBVTT

1
00:00:00.000 --> 00:00:04.760
A useful project notebook has to survive
the moment when you forget what you meant.

2
00:00:05.143 --> 00:00:08.046
In this lesson, we will
make a small Markdown page

3
00:00:08.092 --> 00:00:10.937
that another person can
read, navigate, and use.

4
00:00:11.111 --> 00:00:14.547
We will check both the text we type
and the page that the reader sees.

5
00:00:14.930 --> 00:00:18.135
You need the Sensor Monitor
exercise folder and your editor.

6
00:00:18.413 --> 00:00:20.839
You do not need a physical
board for this work.

7
00:00:21.223 --> 00:00:25.785
Open the project README. Notice
that it is a plain text file.

8
00:00:25.959 --> 00:00:30.534
The hash marks, backticks, brackets, and
vertical bars are visible in the source.

9
00:00:30.743 --> 00:00:34.655
A Markdown renderer gives some of
that punctuation a structural meaning.

10
00:00:34.980 --> 00:00:38.963
A heading becomes a heading. A
fenced block becomes a block of code.

11
00:00:39.241 --> 00:00:42.620
The source and the rendered page
are two views of one document,

12
00:00:42.771 --> 00:00:44.234
and both deserve review.

13
00:00:44.838 --> 00:00:46.835
Start with one title for the document.

14
00:00:47.160 --> 00:00:50.434
Use a single hash mark, a
space, and Sensor Monitor.

15
00:00:50.875 --> 00:00:54.091
Below it, write one sentence
explaining the purpose.

16
00:00:54.474 --> 00:00:58.874
A useful version says that this
baseline prints a fixed synthetic report

17
00:00:58.921 --> 00:01:03.008
on the computer. Shared policy
arrives at checkpoint five.

18
00:01:03.333 --> 00:01:06.978
That sentence tells the reader what
they can accomplish. It also prevents

19
00:01:07.025 --> 00:01:11.088
them from assuming that a physical
sensor is required before they can begin.

20
00:01:11.599 --> 00:01:14.106
Now add a second-level
heading for the first check.

21
00:01:14.489 --> 00:01:18.228
Two hash marks create that level.
Keep the heading descriptive.

22
00:01:18.611 --> 00:01:22.616
Run synthetic replay is more helpful
than More information because it names

23
00:01:22.663 --> 00:01:27.145
an action. Leave a blank line before
the paragraph that explains the action.

24
00:01:27.470 --> 00:01:30.755
Consistent spacing helps people
read the source and reduces

25
00:01:30.802 --> 00:01:34.099
surprises when another renderer
processes the document.

26
00:01:34.482 --> 00:01:38.244
Before the command, tell the reader
where to run it. In this project,

27
00:01:38.302 --> 00:01:42.447
the starting point is the Sensor Monitor
root, the folder containing scripts,

28
00:01:42.563 --> 00:01:46.998
docs, host, and firmware. The working
directory is part of the instruction.

29
00:01:47.276 --> 00:01:51.096
A correct relative path can fail when
the terminal is in a different folder.

30
00:01:51.421 --> 00:01:55.229
That is a documentation problem you
can prevent with one clear sentence.

31
00:01:55.473 --> 00:01:58.863
Put the supplied replay command
inside a fenced code block.

32
00:01:59.246 --> 00:02:02.892
The opening line has three backticks
followed by the word PowerShell.

33
00:02:03.101 --> 00:02:05.167
The closing line has three backticks.

34
00:02:05.492 --> 00:02:09.788
Copy the command from the written lesson
so that its punctuation remains exact.

35
00:02:10.066 --> 00:02:14.420
Do not include the terminal prompt in
the block. A prompt shows where a command

36
00:02:14.467 --> 00:02:17.567
was entered; it is not part of
what the learner should execute.

37
00:02:18.008 --> 00:02:22.141
The language label tells the renderer
and the reader what kind of text follows.

38
00:02:22.524 --> 00:02:26.808
It does not run the command, check the
script, or establish that tests passed.

39
00:02:27.760 --> 00:02:32.659
Those are separate actions. The supplied
dot cmd wrapper is reviewable course code

40
00:02:32.694 --> 00:02:36.514
and should be used with the documented
setup. If your environment blocks it,

41
00:02:36.630 --> 00:02:40.403
preserve the message and follow the
approved setup path instead of changing

42
00:02:40.484 --> 00:02:44.339
broad machine settings. Add a relative
link to the hardware reference.

43
00:02:44.780 --> 00:02:47.206
The visible label should
say hardware reference,

44
00:02:47.357 --> 00:02:51.049
and the destination should be
docs slash hardware dot md.

45
00:02:51.374 --> 00:02:55.148
From this root README, that path
points into the docs folder.

46
00:02:55.589 --> 00:02:59.606
A descriptive label tells the reader
why they might follow the link. A label

47
00:02:59.652 --> 00:03:03.414
that says click here loses that
meaning when read out of context.

48
00:03:03.855 --> 00:03:09.138
Now add a small table with three columns:
action, establishes, and limitation.

49
00:03:09.463 --> 00:03:13.051
In the first row, use baseline
host replay as the action.

50
00:03:13.434 --> 00:03:16.870
Explain that it builds and prints
the fixed synthetic report,

51
00:03:17.079 --> 00:03:20.864
without establishing electrical
behavior. In another row,

52
00:03:21.108 --> 00:03:25.136
distinguish firmware compilation
from successful physical operation.

53
00:03:25.519 --> 00:03:30.442
The rows are genuinely comparable, so
a table helps. A long troubleshooting

54
00:03:30.500 --> 00:03:34.238
explanation would be easier to read
as ordinary prose under a heading.

55
00:03:34.680 --> 00:03:39.149
Open the Command Palette and search
for Markdown: Open Preview to the Side.

56
00:03:39.474 --> 00:03:43.317
You should now be able to compare the
source with its rendered result. Inspect

57
00:03:43.352 --> 00:03:47.427
the title, the second-level heading, the
command block, the link, and the table.

58
00:03:47.810 --> 00:03:50.539
Do not judge only whether
the page looks attractive.

59
00:03:50.655 --> 00:03:54.253
Ask whether a reader can find the
next action and copy exactly the text

60
00:03:54.277 --> 00:03:57.527
they need. We will introduce
a small fault in the exercise

61
00:03:57.574 --> 00:04:01.103
copy. Remove the opening fence
from the command block and inspect

62
00:04:01.138 --> 00:04:04.749
the preview again. Depending on
the surrounding text, the command

63
00:04:04.807 --> 00:04:08.452
can lose its intended presentation
or affect the material that follows.

64
00:04:09.056 --> 00:04:13.259
The important observation is that a tiny
source change can alter how the reader

65
00:04:13.317 --> 00:04:17.241
interprets the procedure. Restore
the fence and compare the result.

66
00:04:17.937 --> 00:04:22.790
Next, follow the hardware link from the
preview. Check the opened file's identity.

67
00:04:23.034 --> 00:04:25.855
A link is not correct merely
because something opens;

68
00:04:26.029 --> 00:04:27.863
it must open the intended document.

69
00:04:28.247 --> 00:04:31.904
Return to the README and consider
the same link from a nested document.

70
00:04:32.345 --> 00:04:36.571
Relative paths start from the document
containing them, so a path that works here

71
00:04:36.629 --> 00:04:39.369
may need adjustment in a
handoff under the docs folder.

72
00:04:39.972 --> 00:04:44.152
Copy the command from the preview and
inspect the pasted text before execution.

73
00:04:44.593 --> 00:04:48.970
Confirm that no prompt, closing
punctuation, or explanation came along.

74
00:04:49.481 --> 00:04:53.301
If your tools are ready, you can run the
documented check and record the actual

75
00:04:53.370 --> 00:04:55.298
outcome. If they are not,

76
00:04:55.576 --> 00:04:59.791
finish the formatting and link checks
and leave execution explicitly open.

77
00:05:00.301 --> 00:05:04.354
Expected output and observed output
belong to different evidence categories.

78
00:05:04.795 --> 00:05:07.790
Your exercise is to create
a page with one title,

79
00:05:07.999 --> 00:05:11.424
two useful headings, an
ordered procedure, the command,

80
00:05:11.575 --> 00:05:14.234
the relative link, and
the small evidence table.

81
00:05:14.838 --> 00:05:17.473
Introduce and repair one formatting fault.

82
00:05:17.798 --> 00:05:20.120
Save a brief note saying what failed,

83
00:05:20.248 --> 00:05:23.476
what you changed, and which
checks you actually performed.

84
00:05:23.917 --> 00:05:27.017
You can pause here and complete
that work before continuing.

85
00:05:27.458 --> 00:05:30.767
When reviewing your result,
explain why both views matter.

86
00:05:31.208 --> 00:05:34.343
The source preserves
exact syntax and paths.

87
00:05:34.726 --> 00:05:37.768
The preview shows the reading
and copying experience.

88
00:05:38.209 --> 00:05:40.635
A screenshot can illustrate either view,

89
00:05:40.844 --> 00:05:44.385
but it cannot replace selectable
commands and a clear explanation.

90
00:05:44.768 --> 00:05:48.634
This is the beginning of a notebook
that helps someone reproduce the work,

91
00:05:48.913 --> 00:05:53.081
including the future version of you
who no longer remembers the setup.