Skip to content

Commit bb45748

Browse files
committed
Updates for intro session 1
1 parent e0edc37 commit bb45748

File tree

3 files changed

+29
-28
lines changed

3 files changed

+29
-28
lines changed

public/intro-code.pdf

75.8 KB
Binary file not shown.

src/Exercises.elm

+24-21
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ import SliceShow.Content exposing (..)
88
import SliceShow.Slide exposing (..)
99

1010

11+
codeAnnotationLink =
12+
"https://annotate.codereading.club/#/file/MIewJgpgShCGYEsB2BzYAbArgIwM4HoZcRMAnAYwgO3RG3wFYBmcgJgAYAOATkqYEYA7ADNh2AGzYALP06cpYLmDDlBrWNlhNIcCJ3wBlAC6xSRiKQDSCI4aq4EIJFIC0sJGBfYIATydh8cnAIF1wkBAAHCIgjAnRkKgARCCDSWCNHJFwAOljA4NyADyMgA"
13+
14+
15+
codePdf =
16+
"/intro-code.pdf"
17+
18+
1119
glanceAndAnnotateAnnotate =
1220
"https://annotate.codereading.club/#/file/M4Sw5gdghgNlAO8D0Blc0YFoQHkVICMYB7AwgNgA4ATSqAZgGNKBGAFgHYAzAUwICYC5AJw8Obfiyjl+AVnIAGSozZsCwyuVn9U6WEmAAnRkgCyxajxjAkABQAWxCDwByAVwC2BHoYBqsEGooABdiQwA6YAB3EC5go"
1321

@@ -214,9 +222,9 @@ sectionIntroFromSection section =
214222
[ slideP "The goal of this exercise is to practice to get a first impression of code and act upon that."
215223
, slideP "We all have different instincts and strategies for where to start when faced with a new piece of code."
216224
|> hide
217-
, bulletLink "Code in the annotation tool" glanceAndAnnotateAnnotate
225+
, bulletLink "Code in the annotation tool" codeAnnotationLink
218226
|> hide
219-
, bulletLink "Code pdf" glanceAndAnnotatePdf
227+
, bulletLink "Code pdf" codePdf
220228
|> hide
221229
, slideP "It doesn't matter how trivial you think the first and second things you noticed are."
222230
|> hide
@@ -298,7 +306,7 @@ slideContent section =
298306
, slideP "[email protected] | https://codereading.club"
299307
, slideHr
300308
, bullets
301-
[ bulletLink "Code of conduct" "https://codereading.club/conduct"
309+
[ bulletLink "Code of conduct" "https://codereading.club/code-of-conduct"
302310
, bulletLink "Group workspace" groupWorkspaceLink
303311
, bulletLink "Code in annotation tool" annotationLink
304312
, if String.length pdfLink > 0 then
@@ -340,8 +348,8 @@ slideContent section =
340348
, styledSeparator
341349
, slideHeading3 "What is Code Reading Club?"
342350
, bullets
343-
[ bulletLink "Code of conduct" "https://codereading.club/conduct"
344-
, bullet "codereading.club/conduct"
351+
[ bulletLink "Code of conduct" "https://codereading.club/code-of-conduct"
352+
, bullet "codereading.club/code-of-conduct"
345353
, bullet ""
346354
, bulletLink "Group workspace" groupWorkspaceLink
347355
, bullet ""
@@ -377,9 +385,9 @@ slideContent section =
377385
, slideHeading2 "The plan" |> hide
378386
, bullets
379387
[ bullet "1. What is Code Reading Club?"
380-
, bullet "2. The foundations of Code Reading Club"
388+
, bullet "2. First glance at the code"
381389
, bullet "3. Why are we here?"
382-
, bullet "4. Exercise tasters (with break)"
390+
, bullet "4. Four exercises (with break)"
383391
, bullet "5. Questions & Answers"
384392
]
385393
|> hide
@@ -391,8 +399,8 @@ slideContent section =
391399
, styledSeparator
392400
, slideHeading3 "What is Code Reading Club?"
393401
, bullets
394-
[ bulletLink "Code of conduct" "https://codereading.club/conduct"
395-
, bullet "https://codereading.club/conduct"
402+
[ bulletLink "Code of conduct" "https://codereading.club/code-of-conduct"
403+
, bullet "https://codereading.club/code-of-conduct"
396404
, bullet ""
397405
, bulletLink "Code pdf tool" "https://pdf.codereading.club"
398406
, bullet "https://pdf.codereading.club"
@@ -401,11 +409,6 @@ slideContent section =
401409
, bullet "https://annotate.codereading.club"
402410
, bullet ""
403411
, bullet "Discord community & github (@CodeReadingClubs) with resources"
404-
, if String.length pdfLink > 0 then
405-
bulletLink "Example annotation" pdfLink
406-
407-
else
408-
item (text "")
409412
]
410413
]
411414
)
@@ -603,7 +606,7 @@ slideContent section =
603606
)
604607
, ( True
605608
, slideHeadingFromSection section
606-
++ [ timedHeading "2" "3 People" "Share your first, second & why"
609+
++ [ timedHeading "5" "Together" "Share your first, second & why"
607610
, slideP "It might be tempting for some people to start talking about the big picture, but for this exercise we focus on the details we notice, rather than attempt to summarise."
608611
, slideHeading3 "Talk about why things might have jumped out for different people."
609612
, bullets
@@ -701,10 +704,10 @@ slideContent section =
701704
, slideHeadingFromSection section
702705
++ [ timedHeading "5" "In Pairs" "Identify things that are named"
703706
, bullets
704-
[ bulletLink "Code in the annotation tool" namesAnnotate
705-
, bulletLink "Code pdf" namesPdf
707+
[ bulletLink "Code in the annotation tool" codeAnnotationLink
708+
, bulletLink "Code pdf" codePdf
706709
]
707-
, slideP "Use the annotation tool to highlight names. This is one method for discovering how the code fits together and its intentions."
710+
, slideP "Use paper & pen, or the annotation tool, to highlight names. This is one method for discovering how the code fits together and its intentions."
708711
]
709712
)
710713
, ( True
@@ -730,8 +733,8 @@ slideContent section =
730733
, slideHeadingFromSection section
731734
++ [ timedHeading "3" "Independently" "Examine the line"
732735
, bullets
733-
[ bulletLink "Code in the annotation tool" randomAnnotate
734-
, bulletLink "Code pdf" randomPdf
736+
[ bulletLink "Code in the annotation tool" codeAnnotationLink
737+
, bulletLink "Code pdf" codePdf
735738
]
736739
, slideP "Select a random line. It can be helpful to randomly pick 3 line numbers and have the facilitator choose from them, which they think will be most interesting to talk about; but surprisingly, even a blank line can generate some conversation!"
737740
, slideP "Debugging often starts with a line number."
@@ -1029,7 +1032,7 @@ paddedSlide ( showStopwatch, content ) =
10291032
item (img [ src "icon.png", class "stopwatch" ] [])
10301033
, item
10311034
(div [ class "footer" ]
1032-
[ text "Slides for this workshop: https://intro-to-code-reading-club.netlify.app"
1035+
[ text "Slides for this workshop: https://codereadingclub.netlify.app"
10331036
]
10341037
)
10351038
]

src/Slides.elm

+5-7
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To generate a link, go to <https://annotate.codereading.club>
2424
annotationLink : String
2525
annotationLink =
2626
-- e.g. "https://annotate.code-reading.org/#/file/LYewXglgNlCGD0BzApgYwNYgLQBNkDd4AjKEI+HARgAYB2I1ADlmVh1ScoDYjZGBWVEQBMlVJVhdYE2OJwAWZADMAnEuIAnEAHcAzsg3xQOAK5Rku+ABEIu1CHwGAngDoAVruBA"
27-
""
27+
"https://annotate.codereading.club/#/file/MIewJgpgShCGYEsB2BzYAbArgIwM4HoZcRMAnAYwgO3RG3wFYBmcgJgAYAOATkqYEYA7ADNh2AGzYALP06cpYLmDDlBrWNlhNIcCJ3wBlAC6xSRiKQDSCI4aq4EIJFIC0sJGBfYIATydh8cnAIF1wkBAAHCIgjAnRkKgARCCDSWCNHJFwAOljA4NyADyMgA"
2828

2929

3030
{-| A link for a shared workspace for your session
@@ -41,23 +41,23 @@ Leave empty if you don't need downloadable pdf
4141
-}
4242
pdfLink : String
4343
pdfLink =
44-
""
44+
"/intro-code.pdf"
4545

4646

4747
{-| What the code is
4848
-}
4949
codeDescription : String
5050
codeDescription =
5151
-- e.g. "Firefox browser module Discovery.jsm"
52-
""
52+
"VS Code line decorations overlay in typescript"
5353

5454

5555
{-| A link to the code in repo
5656
-}
5757
codeLink : String
5858
codeLink =
5959
-- e.g. "https://github.com/mozilla/gecko-dev/blob/d107bc8aeadcc816ba85cb21c1a6a1aac1d4ef9f/browser/modules/Discovery.jsm"
60-
""
60+
"https://github.com/microsoft/vscode/blob/5150ef0ce77ef5516e55af4b8272f25907b55953/src/vs/editor/browser/viewParts/linesDecorations/linesDecorations.ts"
6161

6262

6363
{-| The list of slides to use for this session
@@ -75,13 +75,11 @@ slides =
7575
, annotationLink = annotationLink
7676
, pdfLink = pdfLink
7777
}
78-
, WhyCodeReading
7978
, FirstGlance
8079
, WhatAreWeThinking
81-
, Syntax
82-
, Break
8380
, RandomLine
8481
, ListNames
82+
, Break
8583
, AnnotateStructure { annotationLink = annotationLink, pdfLink = "" }
8684
, ImportantLines
8785
, DecisionSummary

0 commit comments

Comments
 (0)