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 tutorials #7358

Merged
merged 41 commits into from
Dec 16, 2024
Merged

docs: update tutorials #7358

merged 41 commits into from
Dec 16, 2024

Conversation

ccurme
Copy link
Contributor

@ccurme ccurme commented Dec 12, 2024

Copy link

vercel bot commented Dec 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langchainjs-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 16, 2024 9:09pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langchainjs-api-refs ⬜️ Ignored (Inspect) Dec 16, 2024 9:09pm

@ccurme ccurme marked this pull request as ready for review December 13, 2024 19:47
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Dec 13, 2024
Copy link
Collaborator

@jacoblee93 jacoblee93 left a comment

Choose a reason for hiding this comment

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

Thank you so much for this!

docs/core_docs/vercel.json Show resolved Hide resolved
"- [Prompt Templates](/docs/concepts/prompt_templates)\n",
"- [Chat History](/docs/concepts/chat_history)\n",
"\n",
"This guide requires `langgraph >= 0.2.28`.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

If we are moving all this to use LangGraph, should we just work towards combine docs?

Not in this PR obviously but in general

"\n",
"This guide (and most of the other guides in the documentation) uses [Jupyter notebooks](https://jupyter.org/) and assumes the reader is as well. Jupyter notebooks are perfect for learning how to work with LLM systems because oftentimes things can go wrong (unexpected output, API down, etc) and going through guides in an interactive environment is a great way to better understand them.\n",
"\n",
"This and other tutorials are perhaps most conveniently run in a Jupyter notebook. See [here](https://jupyter.org/install) for instructions on how to install.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can be in a followup but we should have a guide on how to set up TSLab since it's not a typical experience for JS devs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree

docs/core_docs/docs/tutorials/chatbot.ipynb Outdated Show resolved Hide resolved
docs/core_docs/docs/tutorials/chatbot.ipynb Show resolved Hide resolved
docs/core_docs/docs/tutorials/sql_qa.ipynb Outdated Show resolved Hide resolved
docs/core_docs/docs/tutorials/sql_qa.ipynb Outdated Show resolved Hide resolved
docs/core_docs/docs/tutorials/sql_qa.ipynb Outdated Show resolved Hide resolved
docs/core_docs/docs/tutorials/summarization.ipynb Outdated Show resolved Hide resolved
"}\n",
"\n",
"// Here we generate a summary, given a document\n",
"const generateSummary = async (state: SummaryState): Promise<{ summaries: string[] }> => {\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why declare another type here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jacoblee93 jacoblee93 merged commit 05cccee into main Dec 16, 2024
7 checks passed
@jacoblee93 jacoblee93 deleted the cc/update_tutorials branch December 16, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants