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

docs: update tutorial according to the code sample [Introduction] #38

Merged
merged 3 commits into from
Apr 10, 2024

Conversation

glaucia86
Copy link
Contributor

@glaucia86 glaucia86 commented Apr 9, 2024

Purpose

This PR is related to #37

  • 01 - Introduction

  • ...

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

This pull request includes significant additions to the tutorial documentation, introducing a new tutorial for creating a serverless ChatGPT with RAG using LangChain.js and TypeScript, and setting up the serverless environment using Azure Functions.

  • docs/tutorial/01-introduction.md: A comprehensive introduction to the tutorial was added, including an overview of the project, its architecture, prerequisites, and steps to execute the project. This tutorial guides the user through creating a serverless ChatGPT and RAG application using LangChain.js, Azure Functions, Azure Cosmos DB, Azure Blob Storage, and Azure Static Web Apps. The chatbot will be able to answer questions based on a set of enterprise documents uploaded from a fictional company called Contoso Real Estate.
  • docs/tutorial/02-setting-up-azure-functions.md: This file was created to host the tutorial content for setting up the serverless environment using Azure Functions. Currently, it contains a placeholder for the content to be added in the future.

@glaucia86 glaucia86 assigned glaucia86 and unassigned glaucia86 Apr 9, 2024
@glaucia86 glaucia86 added the documentation Improvements or additions to documentation label Apr 9, 2024
@glaucia86 glaucia86 linked an issue Apr 9, 2024 that may be closed by this pull request
8 tasks
Copy link
Contributor

@sinedied sinedied left a comment

Choose a reason for hiding this comment

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

Made a few comments, otherwise LGTM

docs/tutorial/01-introduction.md Outdated Show resolved Hide resolved
docs/tutorial/01-introduction.md Show resolved Hide resolved
docs/tutorial/01-introduction.md Outdated Show resolved Hide resolved
docs/tutorial/01-introduction.md Show resolved Hide resolved
@glaucia86 glaucia86 changed the title docs: update tutorial according to the code sample docs: update tutorial according to the code sample [Introduction] Apr 10, 2024
@glaucia86 glaucia86 requested a review from sinedied April 10, 2024 16:01
@glaucia86
Copy link
Contributor Author

Made a few comments, otherwise LGTM

@sinedied I made the changes :)

@glaucia86 glaucia86 merged commit 7cff957 into main Apr 10, 2024
5 checks passed
@glaucia86 glaucia86 deleted the GL/01-session-tutorial-serverless branch April 10, 2024 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs]: Update tutorial folder according to the code sample
2 participants