Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(curriculum): add English curriculum block 7.2 Reading and understanding code documentation #54197

Merged
merged 7 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,160 @@
"isBeta": true,
"challengeOrder": [
{
"id": "655c1715102daf9d3d0d3330",
"title": "Dialogue: Placeholder"
"id": "65fd595245455d0dca3434ba",
"title": "Dialogue 1: Navigating Documentation"
},
{
"id": "65fd5a9680a9540e9787dec5",
"title": "Task 1"
},
{
"id": "65fd5c89285ea50f25bd0241",
"title": "Task 2"
},
{
"id": "65fd5d1a6cb7f10f77a06163",
"title": "Task 3"
},
{
"id": "65fd5da902959d0fda781aa3",
"title": "Task 4"
},
{
"id": "65fd5dfc174596101eae1107",
"title": "Task 5"
},
{
"id": "65fd5f2abfdbc510942d76f8",
"title": "Task 6"
},
{
"id": "65fd5f86457b4910e35b51c9",
"title": "Task 7"
},
{
"id": "65fd620e9ba99c116c42c361",
"title": "Task 8"
},
{
"id": "65fd63be9afd7611d2a9b788",
"title": "Task 9"
},
{
"id": "65ffa914bc44081a196fa6f7",
"title": "Task 10"
},
{
"id": "65ffa9d80e7ffb1ab9b4df1c",
"title": "Task 11"
},
{
"id": "65fff2b49779301d9bdab6fa",
"title": "Task 12"
},
{
"id": "65fff336d7553c1df86f7968",
"title": "Task 13"
},
{
"id": "65fff428290eaa1e5819c119",
"title": "Task 14"
},
{
"id": "65fff57ce568cf1ed9702fbf",
"title": "Task 15"
},
{
"id": "66000a440c2f492ddee509f9",
"title": "Dialogue 2: Understanding Function Descriptions"
},
{
"id": "66000ac46e87f52e84328b95",
"title": "Task 16"
},
{
"id": "66000eeeec06b6338a5c5caf",
"title": "Task 17"
},
{
"id": "66000f74c71b623407a8394e",
"title": "Task 18"
},
{
"id": "66000fec4b5a8c348421fada",
"title": "Task 19"
},
{
"id": "6600107b9dffa8350e0c4ee8",
"title": "Task 20"
},
{
"id": "660011289b5237359f69c76b",
"title": "Task 21"
},
{
"id": "660011d015f7d43626524ef8",
"title": "Task 22"
},
{
"id": "660012a18576e836ea18fa0b",
"title": "Task 23"
},
{
"id": "660012ff748bf2375c31b591",
"title": "Task 24"
},
{
"id": "660013ce54713f37ecac079d",
"title": "Task 25"
},
{
"id": "6600144958b1d33857b0309f",
"title": "Task 26"
},
{
"id": "660014d3f5b02038de6ac35c",
"title": "Task 27"
},
{
"id": "660019617debd03c767e0a3d",
"title": "Dialogue 3: Understanding Parameters and Options"
},
{
"id": "66001985c091f13cda6d4f4d",
"title": "Task 28"
},
{
"id": "66001a1c9df0a83d8e8c670a",
"title": "Task 29"
},
{
"id": "66001a935988e43e1183bd38",
"title": "Task 30"
},
{
"id": "66001b1aa59adc3ea4b024b4",
"title": "Task 31"
},
{
"id": "66001b8d0518d03f18b19715",
"title": "Task 32"
},
{
"id": "66001be61f20a33f8a45f3cb",
"title": "Task 33"
},
{
"id": "66001cac957f0740252c2611",
"title": "Task 34"
},
{
"id": "66001d1ffd0e0b40a8cbf0c7",
"title": "Task 35"
},
{
"id": "66001d8b878f5141214f2d77",
"title": "Task 36"
}
],
"helpCategory": "English"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
id: 655c1715102daf9d3d0d3330
title: "Dialogue: Placeholder"
id: 65fd595245455d0dca3434ba
title: "Dialogue 1: Navigating Documentation"
challengeType: 21
videoId: nLDychdBwUg
dashedName: dialogue-placeholder
dashedName: dialogue-1-navigating-documentation
---

# --description--
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: 65fd5a9680a9540e9787dec5
title: Task 1
challengeType: 22
dashedName: task-1
---

<!--
AUDIO REFERENCE:
Tom: I'm trying to understand the code documentation, but it's quite overwhelming. What should I do to navigate it more effectively?
-->

# --description--

`Overwhelming` means feeling like something is too much to handle.

For example, `The amount of information was overwhelming.` (meaning it was a lot!)

`Effective` is an adjective that describes something producing a desired result. Like, `An effective method`.

`Effectively` is an adverb, meaning in an `effective` way. For instance, `He completed the task effectively.`

# --fillInTheBlank--

## --sentence--

`I'm trying to understand the code documentation, but it's quite _. What should I do to navigate it more _?`

## --blanks--

`overwhelming`

### --feedback--

This word describes a situation where something feels too difficult or too much to handle.

---

`effectively`

### --feedback--

This word means in a way that is successful and achieves what you want.
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
id: 65fd5c89285ea50f25bd0241
title: Task 2
challengeType: 19
dashedName: task-2
---

<!--
AUDIO REFERENCE:
Tom: I'm trying to understand the code documentation, but it's quite overwhelming. What should I do to navigate it more effectively?
-->

# --description--

Answer the question below.

# --question--

## --text--

What is Tom's main concern and what is he asking for?

## --answers--

He finds the code documentation overwhelming and is asking for ways to navigate it more effectively.

---

Tom wants to rewrite the code documentation.

### --feedback--

Tom's concern is about understanding the existing documentation, not about rewriting it.

---

He is asking for help to reduce the amount of documentation.

### --feedback--

Tom's issue is not with the quantity of the documentation but with how to understand it more effectively.

---

Tom is looking for someone to explain the entire documentation to him.

### --feedback--

While Tom is seeking help, he specifically asks for ways to navigate the documentation more effectively, not for a full explanation.

## --video-solution--

1
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
id: 65fd5d1a6cb7f10f77a06163
title: Task 3
challengeType: 22
dashedName: task-3
---

<!--
AUDIO REFERENCE:
Sarah: Don't worry. When you're faced with extensive documentation, the first thing you should do is check for a table of contents or an index.
-->

# --description--

`To be faced with` means to encounter or confront something, usually a challenge. For example, `She was faced with a difficult decision` meaning being in a situation where she needs to deal with something.

A `table of contents` is a list at the beginning of a document, showing its structure. Like in a book, `The table of contents lists all the chapters.`

# --fillInTheBlank--

## --sentence--

`Don't _. When you're _ with extensive documentation, the first thing you should do is check for a _ of contents or an index.`

## --blanks--

`worry`

### --feedback--

It means to feel anxious or concerned. Sarah is telling Tom not to feel overwhelmed.

---

`faced`

### --feedback--

It means encountering or dealing with something, often a problem or challenge.

---

`table`

### --feedback--

This word in this context is part of `table of contents`, which helps navigate a document by listing its main parts.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
id: 65fd5da902959d0fda781aa3
title: Task 4
challengeType: 22
dashedName: task-4
---

# --description--

`Extensive` means large in amount or scope. For example, `The researcher conducted an extensive study.` It conveys something vast or wide-ranging.

An `index` is a list, usually at the end of a book or document, that tells you where to find specific information. Like, `I used the index to find the topic I was interested in.`

# --fillInTheBlank--

## --sentence--

`When you're faced with _ documentation, the first thing you should do is _ for a table of contents or an _.`

## --blanks--

`extensive`

### --feedback--

This word describes something that is large or comprehensive. Sarah uses it to describe the vast amount of documentation.

---

`check`

### --feedback--

It means to look at something to confirm its presence or accuracy. Sarah suggests verifying if there is a table of contents or an index.

---

`index`

### --feedback--

It's a list in a document or book used for finding specific information.