Skip to content

docs: -adding lesson 2 #7

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 15 commits into from
Feb 18, 2025
Merged

docs: -adding lesson 2 #7

merged 15 commits into from
Feb 18, 2025

Conversation

softchris
Copy link
Collaborator

@softchris softchris commented Jan 30, 2025 •
edited
Loading

@softchris softchris changed the title DRAFT - lesson 2 first commit lesson 2 docs: DRAFT - lesson 2 first commit lesson 2 Jan 30, 2025
@softchris softchris changed the title docs: DRAFT - lesson 2 first commit lesson 2 docs: -adding lesson 2 Jan 30, 2025
@sinedied
Copy link
Contributor

sinedied commented Feb 14, 2025 •
edited
Loading

Some comments:

  • The getting started steps are unclear: it looks like steps, but seems more like alternatives? Shouldn't we make it clearer that you need to clone your fork OR open your fork in GitHub Codespaces?
    • Suggestion: use <summary>/<details> for this section, so it's folded by default (as it will be present in all lesssons?) and more detailed
  • Would be nice to add links to the related slides in the Related resources section, like in part 5 ie:
 🎥 Click on the image above to watch a short video about XXX

Slides: [pptx](https://github.com/microsoft/generative-ai-with-javascript/blob/b9f72062fea30ae2c6a26ecb2407e73a756a9b4b/videos/slides/03-rag.pptx) / [pdf](https://github.com/microsoft/generative-ai-with-javascript/blob/b9f72062fea30ae2c6a26ecb2407e73a756a9b4b/videos/slides/pdf/03-rag.pdf)

  • Image size is better, maybe we could improve the display with <img align="left" src="img.jpg"> or <img align="right" src="img.jpg"> to float the images in the text? (despite the name, it should float wrap the text around)

  • Add link to the tools in "Dev setup"

  • First app code: rename augmentedPrompt to just prompt

  • "You:, that wasn't much," => extra , at the beginning

  • It seems there are some markdown issue, I see some ** in the text

  • I don't see where you mention the references at the end in the lesson?

@softchris softchris merged commit 46497fb into microsoft:lessons Feb 18, 2025
1 check passed
softchris added a commit that referenced this pull request Feb 28, 2025
@softchris @sinedied
@DanWahlin @manekinekko @diberry
Lessons (#44)
169b039 
* refactor: prepare for curriculum

* chore: copy .vscode folder

* docs: adding ch1 (#4)

* chore: moving video content to subfolder, adding new README (#3)

Co-authored-by: Chris <[email protected]>

* adding ch1

* updating lesson

* removing files

* moved to lessons folder and fixed narrative

* adding video

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

* adding character demo

* update get started

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

* Revise Chapter 1 README for clarity and consistency

Multiple updates throuughout including shortening some unnecessary parts of the story, adding a little more detail here and there, and telling people where to go to learn more about prompting in the Assignment.

* Add code sneak peek section to README

Decided we should give people a little more from the technical side so added this "sneak peek" section.

* fixing narrative, instructions and more

* fix image viewport

* fix image viewport

* Remove "Getting Started" section from README

* removing gen ai videos folder

---------

Co-authored-by: Chris <[email protected]>
Co-authored-by: Dan Wahlin <[email protected]>

* docs: -adding lesson 2 (#7)

* first commit lesson 2

* adding lesson

* Update 02-first-ai-app/solution/solution.md

* Update 02-first-ai-app/solution/solution.md

* moved and improved narrative

* minor correction

* fix image size

* fix image size

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

* bug bash fixes, adding sanple app

* adding audio and character demo

* adding missing packages

* update get started

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

* fix character instruction

---------

Co-authored-by: Chris <[email protected]>

* docs: adding lesson 3 (#8)

* updating content

* updating solution

* fixing text and images

* Update lessons/03-prompt-engineering/README.md

* adding sample app, corrected solution

* adding character demo

* update get started

* Update lessons/03-prompt-engineering/README.md

---------

Co-authored-by: Chris <[email protected]>

* docs: adding lesson 4 (#9)

* adding lesson 4

* Update 04-structured-output/README.md

* Update 04-structured-output/README.md

* Update 04-structured-output/README.md

* fixing text and images

* adding CTA

* fixing sample

* adding character interaction

* adding characters app

* fixing chat

* adding audio

* adding audio

* fix

* Apply suggestions from code review

* Apply suggestions from code review

* shortening story

---------

Co-authored-by: Chris <[email protected]>

* docs: add lesson 5 (#6)

* docs: add lesson 5

* changing story, adding assets, adding quiz solution

* shorten + binding it together better

* integrated narrative a bit more

* Update lessons/05-rag/README.md

* Update lessons/05-rag/README.md

* Update lessons/05-rag/README.md

* adding character demo

* Update lessons/05-rag/README.md

* update get started

---------

Co-authored-by: Chris <[email protected]>
Co-authored-by: chris <[email protected]>

* Create README.md (#12)

* Create README.md

* Update README.md

* Update README.md (#13)

* Shorten narrative (#14)

* shorten, and cleanup

* fix broken link

* fixing image align and other things

* fixing image align and other things

* trying a fix

* trying a fix

* last try

* reinstating styles

* fixing, adding more text, shrinking images

* fixing some more

* padding out with more text

* moving dinocrates image

* moving time beetle image

* fixes to ch1-4

* fixes to ch5

* fixes to ch5

* fixes to ch5

* removing all img alignment

---------

Co-authored-by: Chris <[email protected]>

* Build site (#30)

* shorten, and cleanup

* fix broken link

* fixing image align and other things

* fixing image align and other things

* trying a fix

* trying a fix

* last try

* reinstating styles

* fixing, adding more text, shrinking images

* fixing some more

* padding out with more text

* moving dinocrates image

* moving time beetle image

* fixes to ch1-4

* fixes to ch5

* fixes to ch5

* fixes to ch5

* github pages site

* Add pull request trigger to deploy workflow

---------

Co-authored-by: Chris <[email protected]>

* Update deploy.yml

* Update deploy.yml

* Update deploy.yml

* Update README.md

* docs: update readme (#29)

* docs: move images and rewrite video readme

* docs: update readme

* docs: update readme

* docs: update readme

* docs: fix links

* Update README.md

---------

Co-authored-by: chris <[email protected]>

* docs: Update root README.md + setup (#34)

* Update README.md

* improving README and adding a setup directory

* improving azure setup

* adding setup steps

* improving setup file

---------

Co-authored-by: Chris <[email protected]>

* Update README.md

* Update getting-started-azure-openai.md

* Update getting-started-azure-openai.md

* feature: one app v2 (#32)

* shorten, and cleanup

* fix broken link

* adding app

* created an app that can be reused for all characters

* fixing issue

* adding speech

* adding voices to the characters

* making voice opt in via checkbox

* chore: update one app (wip)

* fixed bug, system message wasn't updated

* feat: load character from URL

* feat: improve chat conversation UI

* feat: use custom avatars

* chore: minor typo

* cleaning up, removing template, fix bug with cancelling speech

---------

* switch out chat app image (#36)

* switch out chat app image

* changed to chat image for an updated one

* Update README.md (#35)

* Update README.md

* adding changes

* changes

* adding video description sentence

* fixing navigation

* docs: update lessons with slides (#39)

* Update README.md

* adding pptx, descriptions and slides per lesson

* Update README.md

* Update solution.md

* Update README.md

* Update README.md (#40)

* Update README.md

* Update README.md

* adding disclaimer to app for responsible AI

* Softchris patch 9 (#41)

* Update README.md

* Update README.md

* adding disclaimer to app for responsible AI

* add link to resp AI principles

* docs: peer review updates (#42)

* Update README.md

* fixing a lot of small things

* smaller fixes

* docs: update README.md (#43)

#9 tools and services - in table - has wrong links

* docs: fix links

* Update README.md

* Update README.md

---------

Co-authored-by: sinedied <[email protected]>
Co-authored-by: Chris <[email protected]>
Co-authored-by: Dan Wahlin <[email protected]>
Co-authored-by: Wassim Chegham <[email protected]>
Co-authored-by: Dina Berry (MSFT) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@softchris @sinedied