docs[minor]: Add new QA & RAG use case section (#4211)

* added index & quickstart pages * sources page * chat history notebook * streaming * one more streaming cell * cr * almost finished * agents notebook * local models * cr * commit quickstart * gitignore .md files * docs * cr * cr * lets goooooo * chore: lint files * fix links * cr * drop unnecessary dep * cer * cr * cr
langchain-ai · Feb 5, 2024 · 7b04978 · 7b04978
1 parent 2b4497f
commit 7b04978
Show file tree

Hide file tree

Showing 29 changed files with 4,138 additions and 895 deletions.
diff --git a/.gitignore b/.gitignore
@@ -42,4 +42,5 @@ langchain/api_refs_docs_build/dist/**/*
 
 .docusaurus/
 docs/build/
-docs/api_refs/typedoc.json
+docs/api_refs/typedoc.json
+docs/core_docs/**/*.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -266,6 +266,32 @@ and in generated documentation.
 
 ### Contribute Documentation
 
+#### Install dependencies
+
+##### Note: you only need to follow these steps if you are building the docs site locally.
+
+1. [Quarto](https://quarto.org/) - package that converts Jupyter notebooks (`.ipynb` files) into `.mdx` files for serving in Docusaurus.
+2. `yarn build --filter=core_docs` - It's as simple as that! (or you can simply run `yarn build` from `docs/core_docs/`)
+
+All notebooks are converted to `.md` files and automatically gitignored. If you would like to create a non notebook doc, it must be a `.mdx` file.
+
+### Writing Notebooks
+
+When adding new dependencies inside the notebook you must update the import map inside `deno.json` in the root of the LangChain repo.
+
+This is required because the notebooks use the Deno runtime, and Deno formats imports differently than Node.js.
+
+Example:
+
+```typescript
+// Import in Node:
+import { z } from "zod";
+// Import in Deno:
+import { z } from "npm:/zod";
+```
+
+See examples inside `deno.json` for more details.
+
 Docs are largely autogenerated by [TypeDoc](https://typedoc.org/) from the code.
 
 For that reason, we ask that you add good documentation to all classes and methods.

diff --git a/deno.json b/deno.json
@@ -0,0 +1,14 @@
+{
+  "imports": {
+    "langchain/": "npm:/langchain/",
+    "@langchain/community/": "npm:/@langchain/community/",
+    "@langchain/openai": "npm:@langchain/openai",
+    "@langchain/core/": "npm:/@langchain/core/",
+    "cheerio": "npm:/cheerio",
+    "@langchain/pinecone": "npm:@langchain/pinecone",
+    "@pinecone-database/pinecone": "npm:@pinecone-database/pinecone",
+    "zod": "npm:/zod",
+    "@langchain/anthropic": "npm:@langchain/anthropic",
+    "node-llama-cpp": "npm:/node-llama-cpp"
+  }
+}
diff --git a/docs/core_docs/.gitignore b/docs/core_docs/.gitignore
@@ -29,3 +29,5 @@ yarn-error.log*
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+
+/.quarto/
diff --git a/docs/core_docs/docs/community.md → docs/core_docs/docs/community.mdx b/docs/core_docs/docs/community.md → docs/core_docs/docs/community.mdx
diff --git a/.../docs/ecosystem/integrations/databerry.md → ...docs/ecosystem/integrations/databerry.mdx b/.../docs/ecosystem/integrations/databerry.md → ...docs/ecosystem/integrations/databerry.mdx
diff --git a/...s/docs/ecosystem/integrations/helicone.md → .../docs/ecosystem/integrations/helicone.mdx b/...s/docs/ecosystem/integrations/helicone.md → .../docs/ecosystem/integrations/helicone.mdx
diff --git a/docs/core_docs/docs/get_started/introduction.mdx b/docs/core_docs/docs/get_started/introduction.mdx
@@ -80,7 +80,7 @@ Let models choose which tools to use given high-level directives
 Walkthroughs and techniques for common end-to-end use cases, like:
 
 - [Document question answering](/docs/use_cases/question_answering/)
-- [RAG](/docs/use_cases/rag/code_understanding)
+- [RAG](/docs/use_cases/question_answering/)
 - [Agents](/docs/use_cases/autonomous_agents/)
 - and much more...
 

diff --git a/docs/core_docs/docs/production/deployment.md → .../core_docs/docs/production/deployment.mdx b/docs/core_docs/docs/production/deployment.md → .../core_docs/docs/production/deployment.mdx
diff --git a/docs/core_docs/docs/production/tracing.md → docs/core_docs/docs/production/tracing.mdx b/docs/core_docs/docs/production/tracing.md → docs/core_docs/docs/production/tracing.mdx
diff --git a/docs/core_docs/docs/security.md → docs/core_docs/docs/security.mdx b/docs/core_docs/docs/security.md → docs/core_docs/docs/security.mdx
diff --git a/...docs/use_cases/rag/code_understanding.mdx → ...ocs/docs/use_cases/code_understanding.mdx b/...docs/use_cases/rag/code_understanding.mdx → ...ocs/docs/use_cases/code_understanding.mdx
@@ -1,4 +1,4 @@
-# RAG over code
+# Code Understanding
 
 ## Use case
 

diff --git a/docs/core_docs/docs/use_cases/question_answering/_category_.yml b/docs/core_docs/docs/use_cases/question_answering/_category_.yml
@@ -1,2 +1,2 @@
-label: 'QA and Chat over Documents'
+label: 'Q&A with RAG'
 position: 3
diff --git a/docs/core_docs/docs/use_cases/question_answering/advanced_conversational_qa.mdx b/docs/core_docs/docs/use_cases/question_answering/advanced_conversational_qa.mdx