Skip to content

Commit d47d07e

Browse files
authored
Fix disclaimer and update app/readme (#80)
1 parent 8d1c894 commit d47d07e

File tree

7 files changed

+18
-16
lines changed

7 files changed

+18
-16
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ Dive into an immersive learning experience powered by Generative AI:
3333
- **Epic Time-Travel Stories**.
3434
Dive into a fun tale, chatting with icons like Leonardo da Vinci, Ada Lovelace, or Montezuma in every lesson.
3535

36-
- **Companion App**. Interact with historical figures (Powered by generative AI [See Responsible AI disclaimer](#responsible-ai-disclaimer)
37-
![Interact with History through conversation](./docs/images/character-chat.png)
36+
- **Companion App**. Interact with historical figures using Generative AI technologies ([see our Responsible AI disclaimer](#responsible-ai-disclaimer)).
37+
38+
![Interact with History through conversation](./docs/images/character-chat.png)
39+
3840
Check the [_app_](./app/) directory to run the [app locally](./docs/setup/README.md#option-2--running-the-app-locally) or use [GitHub Codespaces](./docs/setup/README.md) to run it online.
3941

4042
- **Accessibility FTW**. Read it, hear it—audio tags bring it to life.

app/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@ This app allows you to speak to all character features in the curriculum.
22

33
## Installation
44

5-
1. Start a GitHub Codespaces
6-
1. Run `npm install`
7-
1. Run `npm start`
8-
1. Open `http://localhost:3000`
5+
1. Start a [![GitHub Codespace](https://img.shields.io/badge/GitHub-Codespace-brightgreen)](https://codespaces.new/microsoft/generative-ai-with-javascript)
6+
2. Navigate to _/app_ in the repo root.
7+
3. Locate the console and run `npm install` followed by `npm start`.
8+
4. Once it appears, select the "Open in Browser" button.
99

1010
You should see something like:
1111

1212
![Chat app](../docs/images/character-chat.png)
1313

14-
## Speak to a character
14+
## Interact with a character
1515

16-
You're faced with a text input field. Type your message and see the response from the character you are speaking to.
16+
You're faced with a text input field. Type your message and see the response from the character you are chatting with.
1717

18-
## Change character
18+
## Change the character
1919

20-
Select the dropdown to change the character you are speaking to.
20+
Select the character image to change the character you are speaking to.
2121

22-
## Change the character behavior
22+
## Change the character's behavior
2323

2424
In `characters.json`, there's a `description` property that will be used as a system message. If you change this, the characters personality will change.
2525

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ _Time device, “George” the metallic beetle_
162162
If you want to interact with Dinocrates, run the [Characters](/app/README.md) app.
163163

164164
> [!IMPORTANT]
165-
> This all make believe, responses are generated by an AI.
165+
> This is entirely fictional; the responses are generated by AI.
166166
> [Responsible AI disclaimer](../../README.md#responsible-ai-disclaimer)
167167
168168
<div>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Leonardo da Vinci, asking you to help him with a project—you can hardly believ
121121
If you want to interact with Leonardo, run the [Characters](/app/README.md) app.
122122

123123
> [!IMPORTANT]
124-
> This all make believe, responses are generated by an AI.
124+
> This is entirely fictional; the responses are generated by AI.
125125
> [Responsible AI disclaimer](../../README.md#responsible-ai-disclaimer)
126126
127127
<div>

lessons/03-prompt-engineering/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ You look out over the city; the ancient buildings stretch out below you.
113113
If you want to interact with Sforza, run the [Characters](/app/README.md) app.
114114

115115
> [!IMPORTANT]
116-
> This all make believe, responses are generated by an AI.
116+
> This is entirely fictional; the responses are generated by AI.
117117
> [Responsible AI disclaimer](../../README.md#responsible-ai-disclaimer)
118118
119119
<div >

lessons/04-structured-output/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ _Patolli - Wikipedia_
125125
If you want to interact with Montezuma, run the [Characters](/app/README.md) app.
126126

127127
> [!IMPORTANT]
128-
> This all make believe, responses are generated by an AI.
128+
> This is entirely fictional; the responses are generated by AI.
129129
> [Responsible AI disclaimer](../../README.md#responsible-ai-disclaimer)
130130
131131
<div>

lessons/05-rag/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Leonardo nodded, "Sì, it has been acting strangely."
8181
If you want to interact with Ada, run the [Characters](/app/README.md) app.
8282

8383
> [!IMPORTANT]
84-
> This all make believe, responses are generated by an AI.
84+
> This is entirely fictional; the responses are generated by AI.
8585
> [Responsible AI disclaimer](../../README.md#responsible-ai-disclaimer)
8686
8787
<div>

0 commit comments

Comments
 (0)