Skip to content

Code walkthrough#59

Open
AmeliaYe wants to merge 11 commits intoNVIDIA:mainfrom
AmeliaYe:code_walkthrough
Open

Code walkthrough#59
AmeliaYe wants to merge 11 commits intoNVIDIA:mainfrom
AmeliaYe:code_walkthrough

Conversation

@AmeliaYe
Copy link
Collaborator

@AmeliaYe AmeliaYe commented Nov 1, 2024

this pull request is mostly for initial tutorial content check. could add:

  1. style in text
  2. incremental slideshow effect
  3. code block formatt

@AmeliaYe AmeliaYe requested a review from rmkraus November 1, 2024 17:52
@freemansoft
Copy link
Contributor

This PR includes the merge markers around line 209. Looks like a merge conflict was merged incorrectly

deleted merge markers
Copy link
Collaborator

@sophwats sophwats left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can merge, once these small changes are made.

Copy link
Collaborator

@MattFeinberg MattFeinberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left 2 comments on 2 files. Also, I think we should add something to the README about the code walkthrough. It shows up in workbench as an application, but we aren't providing any guidance on why a user might want to turn it on and visit the page.

I think we can add a section right after "Populating the Knowledge Base," maybe call it "Learn About the Code"? Where we call out the Code Walkthrough app and how to use it to learn.

For the actual code walkthrough, what's the purpose of both the HTML and the TXT version? Will users ever actually go to the TXT? Or just the HTML for the slideshow? If it's just the HTML, then I think opening the walkthrough should take you directly to the HTML slideshow, rather than having you choose between TXT and HTML.

I also think the slideshow could benefit from short introduction, so users know what they're looking at. Something like "this slideshow will walk you through files X and Y and how we built a RAG chain."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants