Skip to content

Commit fdc018d

Browse files
Copilotsoftchris
andauthored
Fix formatting, spelling, and link issues in lesson files (#122)
* Initial plan for issue * Fix broken links, header formatting, and quiz questions Co-authored-by: softchris <[email protected]> * Update British spelling to American English Co-authored-by: softchris <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: softchris <[email protected]>
1 parent fb0f4f8 commit fdc018d

File tree

16 files changed

+46
-46
lines changed

16 files changed

+46
-46
lines changed

lessons/01-intro-to-genai/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this chapter you will learn:
1010

1111
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1212

13-
## Related resources
13+
## Related Resources
1414

1515
[![Watch a short video about an Introduction to Generative AI](https://img.youtube.com/vi/vLYtDgs_zx8/0.jpg)](https://www.youtube.com/watch?v=vLYtDgs_zx8&list=PLlrxD0HtieHi5ZpsHULPLxm839IrhmeDk&index=1)
1616

@@ -26,7 +26,7 @@ Moreover, Generative AI has evolved into multimodal capabilities, allowing you t
2626

2727
*Simply put, natural language interfaces are becoming the new standard interface for many apps—and your users expect to use them.*
2828

29-
## Narrative: A journey through time
29+
## Narrative: A Journey Through Time
3030

3131
> [!NOTE]
3232
> Let’s begin with an overview of the story—one that bridges the past and future! As you progress through this curriculum, you'll embark on a thrilling adventure, traveling back in time to collaborate with some of history's greatest minds. Together, you'll tackle challenges and explore how Generative AI can revolutionize your JavaScript applications._
@@ -36,7 +36,7 @@ Moreover, Generative AI has evolved into multimodal capabilities, allowing you t
3636
3737
Your journey begins in 1860s London, where you assume the role of a skilled mechanic. Through a series of gripping adventures, you'll refine your AI skills and unlock solutions that transcend time.
3838

39-
### Into the maelstrom - London 1860
39+
### Into the Maelstrom - London 1860
4040

4141
In the heart of 1860s London, you are recognized as one of the most skilled mechanics of your time. Your workshop is tucked away in a narrow alley. The walls are lined with shelves overflowing with mechanical parts, blueprints, and half-finished projects.
4242

@@ -48,7 +48,7 @@ Your workbench, the heart of your workshop, is an organized mess.
4848

4949
_At the center of the bench lies the torso of a robot—an engineering marvel that has consumed months of effort. Its wooden frame is intricately carved, each joint meticulously designed for smooth movement._
5050

51-
### A letter, for you?
51+
### A Letter, For You?
5252

5353
Suddenly, a knock at the door disrupts your thoughts. Visitors at this hour are rare. Wiping your hands on a rag, you approach the door, curiosity piqued.
5454

@@ -62,7 +62,7 @@ _Yours,_
6262

6363
_Charles Babbage."_
6464

65-
### Off to the library
65+
### Off to the Library
6666

6767
Charles Babbage, the great mathematician and inventor of the difference engine, wants to meet you. Quickly, you grab your coat and head out the door.
6868

@@ -78,7 +78,7 @@ As your eyes adjust to the dim light, you notice a figure in the distance, wavin
7878
<img src="./assets/library.png" alt="Dusty Library" width="300">
7979
</div>
8080

81-
### What's this device?
81+
### What's This Device?
8282

8383
Just as you step closer, a blinding flash erupts, and he vanishes.
8484

@@ -180,7 +180,7 @@ If you want to interact with Dinocrates, run the [Characters](/app/README.md) ap
180180
> [!NOTE]
181181
> If you're running the project locally on your machine, please review the QuickStart guide to get a [GitHub personal access](../../docs/setup/README.md#creating-a-personal-access-token-pat-for-github-model-access) token setup and replace the key in the code.
182182
183-
### Code sneak peek
183+
### Code Sneak Peek
184184

185185
While there is still a lot more to cover in this Generative AI curriculum, let's take a quick peek at the AI code to begin learning about using JavaScript with AI.
186186

@@ -235,7 +235,7 @@ Here's a step-by-step summary of what the function does:
235235
236236
> **Note**: [GitHub Copilot](https://github.com/features/copilot) was used to generate this code summary. Generative AI in action!
237237
238-
### What can Generative AI do for me and my Apps?
238+
### What Can Generative AI Do for Me and My Apps?
239239
240240
> [!NOTE]
241241
> You've probably figured out by now that the time beetle works like an AI assistant that you can interact with using natural language, written or spoken.
@@ -292,7 +292,7 @@ Here's an example of a "chatbot application" in action:
292292
293293
**Time Beetle:** Let's just say that you're in a unique position to interact with historical figures in a way that few others can.
294294
295-
### JavaScript ecosystem
295+
### JavaScript Ecosystem
296296
297297
**You:** So ecosystems you said, I'm just taking notes here, what about JavaScript and how is it different from other ecosystems?
298298
@@ -346,7 +346,7 @@ Visit [Microsoft Copilot](https://copilot.microsoft.com), [ChatGPT](https://chat
346346
347347
[Solution](./solution/solution.md)
348348
349-
### Knowledge check
349+
### Knowledge Check
350350
351351
**Question:** Which of the following statements about Generative AI and JavaScript are true?
352352
@@ -356,6 +356,6 @@ C. Python is the only language used for AI development.
356356
357357
[Quiz solution](./solution/solution-quiz.md)
358358
359-
## Self-Study resources
359+
## Self-Study Resources
360360
361361
- [Generative AI JavaScript video series](https://aka.ms/genai-js)

lessons/01-intro-to-genai/solution/solution-quiz.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Quick Quiz: Test Your Knowledge!
22

3-
### ❓ Question 1:
3+
### ❓ Question 1
44
Generative AI can generate text, images, and even code.
55

66
<details>
@@ -16,7 +16,7 @@ Generative AI is capable of generating a variety of content such as text, images
1616

1717
---
1818

19-
### ❓ Question 2:
19+
### ❓ Question 2
2020
JavaScript can be used for both front-end and back-end development.
2121

2222
<details>
@@ -29,7 +29,7 @@ JavaScript can be used for both front-end and back-end development.
2929

3030
---
3131

32-
### ❓ Question 3:
32+
### ❓ Question 3
3333
Python is not the only language that can be used for AI development. It can be argued that Python is the most popular language for AI development, but other languages/frameworks like JavaScript, Java and Python are also a very popular choices for AI development.
3434

3535
<details>

lessons/01-intro-to-genai/translations/README.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ _时间设备,"乔治"金属甲虫_
163163

164164
> [!IMPORTANT]
165165
> 这完全是虚构的;这些回应是由 AI 生成的。
166-
> [负责任的 AI 免责声明](../../README.md#responsible-ai-disclaimer)
166+
> [负责任的 AI 免责声明](../../../README.md#responsible-ai-disclaimer)
167167
168168
<div>
169169
<img src="../assets/dinocrates.png" alt="身穿托加长袍的迪诺克拉底" width="300">

lessons/02-first-ai-app/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lesson 2: Writing your first AI app
1+
# Lesson 2: Writing Your First AI App
22

33
In this chapter you will learn:
44

@@ -10,7 +10,7 @@ In this chapter you will learn:
1010

1111
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1212

13-
## Related resources
13+
## Related Resources
1414

1515
[![Watch a short video about large language models](https://img.youtube.com/vi/GQ_2OjNZ9aA/0.jpg)](https://www.youtube.com/watch?v=GQ_2OjNZ9aA&list=PLlrxD0HtieHi5ZpsHULPLxm839IrhmeDk&index=2)
1616

@@ -490,7 +490,7 @@ Check out [Sample app](/app/README.md) to get started.
490490
491491
[Solution](./solution/solution.md)
492492
493-
## Knowledge check
493+
## Knowledge Check
494494
495495
**Question:** What is the purpose of the context window in generative AI models? Select all that apply.
496496
@@ -502,7 +502,7 @@ C. The context window determines how creative the AI's responses are.
502502

503503
[Quiz solution](./solution/solution-quiz.md)
504504

505-
## Self-Study resources
505+
## Self-Study Resources
506506

507507
- [Text generation](https://platform.openai.com/docs/guides/text-generation)
508508
- [JavaScript library for OpenAI](https://github.com/openai/openai-node/tree/master/examples)

lessons/02-first-ai-app/solution/solution-quiz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ❓ Question:
1+
### ❓ Question
22

33
### What is the purpose of the context window in generative AI models?
44

lessons/02-first-ai-app/translations/README.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ _这个视频向你介绍了被称为"大语言模型"(LLM)的 AI 模型,
2626
> [!NOTE]
2727
> _我们的故事到目前为止:你是一位制造者,一位来自 1860 年代伦敦的工匠,使用一个名为时间甲虫(Time Beetle)的神秘装置穿越时空。你穿越历史长河,见证了亚历山大灯塔的建造,这是一个古代工程奇迹,你在迪诺克拉底和时间甲虫的帮助下参与了建造。_
2828
>
29-
> 如果你想从头开始了解这个故事并开始学习生成式 AI,请查看[第一课](../01-intro-to-genai/README.md)
29+
> 如果你想从头开始了解这个故事并开始学习生成式 AI,请查看[第一课](/lessons/01-intro-to-genai/README.md)
3030
3131
> [!NOTE]
3232
> 虽然我们建议你跟随故事(这很有趣!),但如果你更喜欢直接跳到技术内容,[点击这里](#与莱昂纳多互动)

lessons/03-prompt-engineering/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lesson 3: Prompt engineering
1+
# Lesson 3: Prompt Engineering
22

33
In this chapter you will learn:
44

@@ -10,7 +10,7 @@ In this chapter you will learn:
1010

1111
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1212

13-
## Related resources
13+
## Related Resources
1414

1515
[![Watch a short video about prompt engineering](https://img.youtube.com/vi/gQ6TlyxBmWs/0.jpg)](https://www.youtube.com/watch?v=gQ6TlyxBmWs&list=PLlrxD0HtieHi5ZpsHULPLxm839IrhmeDk&index=3)
1616

@@ -58,7 +58,7 @@ Leonardo grabs the reins and you both leap into the carriage. With a sharp crack
5858

5959
**You:** No, not Rome, home... home...
6060

61-
A swirl of colours envelops the carriage, the world around you dissolving into a kaleidoscope of light.
61+
A swirl of colors envelops the carriage, the world around you dissolving into a kaleidoscope of light.
6262

6363
## Escape
6464

@@ -322,7 +322,7 @@ Then use the LLM to incorporate these inputs and leverage the chain of thought p
322322

323323
[Solution](./solution/solution.md)
324324

325-
## Knowledge check
325+
## Knowledge Check
326326

327327
**Question:** What is prompt engineering? Select all that apply.
328328

@@ -334,7 +334,7 @@ C. Prompt engineering is about training a model to recognize patterns in data.
334334

335335
[Quiz solution](./solution/solution-quiz.md)
336336

337-
## Self-Study resources
337+
## Self-Study Resources
338338

339339
- [Prompt engineering](https://en.wikipedia.org/wiki/Prompt_engineering)
340340
- [Prompt engineering fundamentals](https://github.com/microsoft/generative-ai-for-beginners/blob/main/04-prompt-engineering-fundamentals/README.md?WT.mc_id=academic-105485-koreyst)

lessons/03-prompt-engineering/solution/solution-quiz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ❓ Question:
1+
### ❓ Question
22

33
### What is prompt engineering?
44

lessons/03-prompt-engineering/translations/README.bn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,4 +373,4 @@ C. **প্রম্পট ইঞ্জিনিয়ারিং হলো এ
373373
---
374374

375375
### **প্রারম্ভিক প্রকল্প:**
376-
শুরু করতে এই **[Starter project](/sample-app/)** ব্যবহার করো!
376+
শুরু করতে এই **[Starter project](/app/README.md)** ব্যবহার করো!

lessons/04-structured-output/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lesson 4: Structured output
1+
# Lesson 4: Structured Output
22

33
In this chapter you will learn:
44

@@ -10,7 +10,7 @@ In this chapter you will learn:
1010

1111
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1212

13-
## Related resources
13+
## Related Resources
1414

1515
It's worth rewatching the video on prompt engineering as it lays the foundation for what you're about to learn in this chapter.
1616

@@ -566,6 +566,6 @@ C. Generating unstructured text.
566566

567567
[Quiz solution](./solution/solution-quiz.md)
568568

569-
## Self-Study resources
569+
## Self-Study Resources
570570

571571
- [Generative AI with JavaScript video series](https://aka.ms/genai-js)

lessons/04-structured-output/solution/solution-quiz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ❓ Question:
1+
### ❓ Question
22

33
### What is structured output used for ?
44

lessons/05-rag/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lesson 5: Talk to your data with Retrieval-Augmented Generation (RAG)
1+
# Lesson 5: Talk to Your Data with Retrieval-Augmented Generation (RAG)
22

33
In this chapter you will learn:
44

@@ -10,7 +10,7 @@ In this chapter you will learn:
1010

1111
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1212

13-
## Related resources
13+
## Related Resources
1414

1515
[![Watch a short video about RAG](https://img.youtube.com/vi/xkFOmx5yxIA/0.jpg)](https://www.youtube.com/watch?v=xkFOmx5yxIA&list=PLlrxD0HtieHi5ZpsHULPLxm839IrhmeDk&index=4)
1616

@@ -330,7 +330,7 @@ const text = Object.values(data.query.pages)[0]?.extract;
330330
331331
[Solution](./solution/rag-www.js)
332332
333-
## Knowledge check
333+
## Knowledge Check
334334
335335
**Question**: What is the role of the retriever in a RAG system?
336336
@@ -342,7 +342,7 @@ C. The retriever finds relevant information from external data sources.
342342
343343
[Quiz solution](./solution/solution-quiz.md)
344344
345-
## Self-Study resources
345+
## Self-Study Resources
346346
347347
- [Retrieval-Augmented Generation and Indexes](https://learn.microsoft.com/azure/ai-studio/concepts/retrieval-augmented-generation)
348348
- **Sample apps**:

lessons/05-rag/solution/solution-quiz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ❓ Question:
1+
### ❓ Question
22

33
### What is the role of the retriever in a RAG system?
44

lessons/05-rag/translations/README.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ _这个视频解释了检索增强生成(RAG),这是一种帮助AI在其
2525
> [!NOTE]
2626
> _我们的故事到目前为止:您是一位来自19世纪60年代伦敦的机械师。您正在研究您的自动机,收到了查尔斯·巴贝奇的一封信,最终带您来到一个图书馆,在那里您拿起了一个时间旅行装置。在时间旅行中,您来到了佛罗伦萨,在那里遇见了达芬奇。您还去了阿兹特克帝国,故事就从这里继续。_
2727
>
28-
> 如果您想从头开始了解故事,请参阅[第1课](../01-intro-to-genai/README.md)
28+
> 如果您想从头开始了解故事,请参阅[第1课](/lessons/01-intro-to-genai/README.md)
2929
3030
> [!NOTE]
3131
> 虽然我们建议您阅读故事(很有趣!),但如果您想直接跳到技术内容,[请点击这里](#interact-with-ada-lovelace)

lessons/06-tool-calling/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lesson 6: Tool calling
1+
# Lesson 6: Tool Calling
22

33
Tool calling, also known as function calling, refers to enhancing your AI model by adding capabilities it previously lacked. The concept involves supplying meta descriptions of your functions, allowing the AI model to determine when a particular tool should be called based on a user's prompt. The idea is to provide it with meta descriptions of your actual functions and make the AI model point out when such a tool should be called given a user's prompt.
44

@@ -12,9 +12,9 @@ In this chapter, you will learn:
1212

1313
If you haven't already, set up your development environment. Here's how you can do it: [Setup your environment](/docs/setup/README.md).
1414

15-
## Related resources
15+
## Related Resources
1616

17-
[![Integrating with function calling](./assets/11-lesson-banner.png?WT.mc_id=academic-105485-koreyst)](https://aka.ms/gen-ai-lesson11-gh?WT.mc_id=academic-105485-koreyst)
17+
[![Integrating with function calling](./assets/11-lesson-banner.png)](https://aka.ms/gen-ai-lesson11-gh?WT.mc_id=academic-105485-koreyst)
1818

1919
_This video explains Tool calling, a method that helps the AI call your functions and thereby expand what it can do_
2020

@@ -410,7 +410,7 @@ function getWeatherForecast(lat, long) {
410410
411411
[Solution](./solution/solution.js)
412412
413-
## Knowledge check
413+
## Knowledge Check
414414
415415
**Question:**
416416
What is the purpose of registering a tool with the AI model?
@@ -435,7 +435,7 @@ C. To allow the AI model to execute tools without requiring metadata.
435435
436436
[Solution quiz](./solution/solution-quiz.md)
437437
438-
## Self-Study resources
438+
## Self-Study Resources
439439
440440
- Explains the [process of tool calling](https://learn.microsoft.com/en-us/semantic-kernel/concepts/ai-services/chat-completion/function-calling/?pivots=programming-language-csharp)
441441
- Tool calling in the [Langchain.js framework](https://js.langchain.com/docs/how_to/tool_calling/)

lessons/06-tool-calling/solution/solution-quiz.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ❓ Question 1:
1+
### ❓ Question 1
22

33
### What is the purpose of registering a tool with the AI model?
44

@@ -11,7 +11,7 @@
1111

1212
---
1313

14-
### ❓ Question 2:
14+
### ❓ Question 2
1515

1616
### What is the role of tool metadata in tool calling?
1717

@@ -26,7 +26,7 @@
2626

2727
---
2828

29-
### ❓ Question 3:
29+
### ❓ Question 3
3030

3131
### Why use tool calling?
3232

0 commit comments

Comments
 (0)