From def3a26c054575e1ed40b9062087e8c0a8899633 Mon Sep 17 00:00:00 2001
From: Jacob Lee <jacoblee93@gmail.com>
Date: Wed, 20 Dec 2023 17:58:44 -0800
Subject: [PATCH] Update docs structure (#3736)

---
 .github/pull_request_template.md              |  2 +-
 .../web_loaders/recursive_url_loader.mdx      |  2 +-
 .../integrations/vectorstores/typeorm.mdx     |  2 +-
 docs/core_docs/docs/modules/agents/index.mdx  |  1 +
 .../docs/modules/callbacks/index.mdx          |  1 +
 docs/core_docs/docs/modules/chains/index.mdx  |  1 +
 .../google_vertex_ai.mdx                      |  2 +-
 .../docs/modules/data_connection/index.mdx    |  2 +
 .../docs/modules/experimental/index.mdx       |  1 +
 docs/core_docs/docs/modules/memory/index.mdx  |  1 +
 .../core_docs/docs/modules/model_io/index.mdx |  1 +
 docs/core_docs/sidebars.js                    | 98 ++++++++++++++++++-
 .../helpers/default_file_contents.ts          |  2 +-
 13 files changed, 108 insertions(+), 8 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index fbe852ecaa7a..d47e1b13b1d6 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,5 +1,5 @@
 <!--
-Thank you for contributing to LangChainJS! Your PR will appear in our next release under the title you set above. Please make sure it highlights your valuable contribution.
+Thank you for contributing to LangChain.js! Your PR will appear in our next release under the title you set above. Please make sure it highlights your valuable contribution.
 
 To help streamline the review process, please make sure you read our contribution guidelines:
 https://github.com/langchain-ai/langchainjs/blob/main/CONTRIBUTING.md
diff --git a/docs/core_docs/docs/integrations/document_loaders/web_loaders/recursive_url_loader.mdx b/docs/core_docs/docs/integrations/document_loaders/web_loaders/recursive_url_loader.mdx
index d76522c542db..57bfa3cfa786 100644
--- a/docs/core_docs/docs/integrations/document_loaders/web_loaders/recursive_url_loader.mdx
+++ b/docs/core_docs/docs/integrations/document_loaders/web_loaders/recursive_url_loader.mdx
@@ -7,7 +7,7 @@ hide_table_of_contents: true
 
 When loading content from a website, we may want to process load all URLs on a page.
 
-For example, let's look at the [LangChainJS introduction](https://js.langchain.com/docs/get_started/introduction) docs.
+For example, let's look at the [LangChain.js introduction](https://js.langchain.com/docs/get_started/introduction) docs.
 
 This has many interesting child pages that we may want to load, split, and later retrieve in bulk.
 
diff --git a/docs/core_docs/docs/integrations/vectorstores/typeorm.mdx b/docs/core_docs/docs/integrations/vectorstores/typeorm.mdx
index 0d16dfa6cdb4..e1dce677a0c8 100644
--- a/docs/core_docs/docs/integrations/vectorstores/typeorm.mdx
+++ b/docs/core_docs/docs/integrations/vectorstores/typeorm.mdx
@@ -1,6 +1,6 @@
 # TypeORM
 
-To enable vector search in a generic PostgreSQL database, LangChainJS supports using [TypeORM](https://typeorm.io/) with the [`pgvector`](https://github.com/pgvector/pgvector) Postgres extension.
+To enable vector search in a generic PostgreSQL database, LangChain.js supports using [TypeORM](https://typeorm.io/) with the [`pgvector`](https://github.com/pgvector/pgvector) Postgres extension.
 
 ## Setup
 
diff --git a/docs/core_docs/docs/modules/agents/index.mdx b/docs/core_docs/docs/modules/agents/index.mdx
index f9b60d4f40bd..a6953e29f204 100644
--- a/docs/core_docs/docs/modules/agents/index.mdx
+++ b/docs/core_docs/docs/modules/agents/index.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+sidebar_class_name: hidden
 ---
 
 # Agents
diff --git a/docs/core_docs/docs/modules/callbacks/index.mdx b/docs/core_docs/docs/modules/callbacks/index.mdx
index f1451ba96fbc..2a767cdb1250 100644
--- a/docs/core_docs/docs/modules/callbacks/index.mdx
+++ b/docs/core_docs/docs/modules/callbacks/index.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+sidebar_class_name: hidden
 ---
 
 # Callbacks
diff --git a/docs/core_docs/docs/modules/chains/index.mdx b/docs/core_docs/docs/modules/chains/index.mdx
index c55284404be0..76b4bd7ed5b3 100644
--- a/docs/core_docs/docs/modules/chains/index.mdx
+++ b/docs/core_docs/docs/modules/chains/index.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+sidebar_class_name: hidden
 ---
 
 # Chains
diff --git a/docs/core_docs/docs/modules/data_connection/experimental/multimodal_embeddings/google_vertex_ai.mdx b/docs/core_docs/docs/modules/data_connection/experimental/multimodal_embeddings/google_vertex_ai.mdx
index 3eb8ab8e43b4..ac916398409a 100644
--- a/docs/core_docs/docs/modules/data_connection/experimental/multimodal_embeddings/google_vertex_ai.mdx
+++ b/docs/core_docs/docs/modules/data_connection/experimental/multimodal_embeddings/google_vertex_ai.mdx
@@ -3,7 +3,7 @@ import CodeBlock from "@theme/CodeBlock";
 # Google Vertex AI
 
 :::info Experimental
-This API is new and may change in future LangChainJS versions.
+This API is new and may change in future LangChain.js versions.
 :::
 
 The `GoogleVertexAIMultimodalEmbeddings` class provides additional methods that are
diff --git a/docs/core_docs/docs/modules/data_connection/index.mdx b/docs/core_docs/docs/modules/data_connection/index.mdx
index d612c2a066f1..3e7fd9e91d7e 100644
--- a/docs/core_docs/docs/modules/data_connection/index.mdx
+++ b/docs/core_docs/docs/modules/data_connection/index.mdx
@@ -1,5 +1,7 @@
 ---
+sidebar_label: Retrieval
 sidebar_position: 1
+sidebar_class_name: hidden
 ---
 
 # Retrieval
diff --git a/docs/core_docs/docs/modules/experimental/index.mdx b/docs/core_docs/docs/modules/experimental/index.mdx
index c438bd88faba..ad8e40736595 100644
--- a/docs/core_docs/docs/modules/experimental/index.mdx
+++ b/docs/core_docs/docs/modules/experimental/index.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+sidebar_class_name: hidden
 ---
 
 # Experimental
diff --git a/docs/core_docs/docs/modules/memory/index.mdx b/docs/core_docs/docs/modules/memory/index.mdx
index 9ed87e3c8fa6..2dc1d23a1211 100644
--- a/docs/core_docs/docs/modules/memory/index.mdx
+++ b/docs/core_docs/docs/modules/memory/index.mdx
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+sidebar_class_name: hidden
 ---
 
 # Memory
diff --git a/docs/core_docs/docs/modules/model_io/index.mdx b/docs/core_docs/docs/modules/model_io/index.mdx
index a47acd7162bb..3b29596c252c 100644
--- a/docs/core_docs/docs/modules/model_io/index.mdx
+++ b/docs/core_docs/docs/modules/model_io/index.mdx
@@ -2,6 +2,7 @@
 sidebar_position: 0
 sidebar_custom_props:
   description: Interface with language models
+sidebar_class_name: hidden
 ---
 
 # Model I/O
diff --git a/docs/core_docs/sidebars.js b/docs/core_docs/sidebars.js
index f3476be04a67..27949955ce6e 100644
--- a/docs/core_docs/sidebars.js
+++ b/docs/core_docs/sidebars.js
@@ -48,7 +48,99 @@ module.exports = {
       label: "Modules",
       collapsed: false,
       collapsible: false,
-      items: [{ type: "autogenerated", dirName: "modules" }],
+      items: [
+        {
+          type: "category",
+          label: "Model I/O",
+          collapsed: true,
+          items: [
+            {
+              type: "autogenerated",
+              dirName: "modules/model_io",
+            },
+          ],
+          link: { type: "doc", id: "modules/model_io/index" },
+        },
+        {
+          type: "category",
+          label: "Retrieval",
+          collapsed: true,
+          items: [
+            {
+              type: "autogenerated",
+              dirName: "modules/data_connection",
+            },
+          ],
+          link: { type: "doc", id: "modules/data_connection/index" },
+        },
+        {
+          type: "category",
+          label: "Agents",
+          collapsed: true,
+          items: [
+            {
+              type: "autogenerated",
+              dirName: "modules/agents",
+            },
+          ],
+          link: { type: "doc", id: "modules/agents/index" },
+        },
+        {
+          type: "category",
+          label: "More",
+          collapsed: true,
+          items: [
+            {
+              type: "category",
+              label: "Chains",
+              collapsed: true,
+              items: [
+                {
+                  type: "autogenerated",
+                  dirName: "modules/chains",
+                },
+              ],
+              link: { type: "doc", id: "modules/chains/index" },
+            },
+            {
+              type: "category",
+              label: "Memory",
+              collapsed: true,
+              items: [
+                {
+                  type: "autogenerated",
+                  dirName: "modules/memory",
+                },
+              ],
+              link: { type: "doc", id: "modules/memory/index" },
+            },
+            {
+              type: "category",
+              label: "Callbacks",
+              collapsed: true,
+              items: [
+                {
+                  type: "autogenerated",
+                  dirName: "modules/callbacks",
+                },
+              ],
+              link: { type: "doc", id: "modules/callbacks/index" },
+            },
+            {
+              type: "category",
+              label: "Experimental",
+              collapsed: true,
+              items: [
+                {
+                  type: "autogenerated",
+                  dirName: "modules/experimental",
+                },
+              ],
+              link: { type: "doc", id: "modules/experimental/index" },
+            },
+          ],
+        },
+      ],
       link: {
         type: "doc",
         id: "modules/index",
@@ -114,7 +206,7 @@ module.exports = {
       items: [{ type: "autogenerated", dirName: "integrations/platforms" }],
       link: {
         type: "generated-index",
-        description: "LangChainJS providers of integrations.",
+        description: "LangChain.js integration providers.",
         slug: "integrations/platforms",
       },
     },
@@ -221,7 +313,7 @@ module.exports = {
       link: {
         type: "generated-index",
         description:
-          "LangChainJS feature integrations with third party libraries, services and more.",
+          "LangChain.js feature integrations with third party libraries, services and more.",
         slug: "integrations/components",
       },
     },
diff --git a/libs/create-langchain-integration/helpers/default_file_contents.ts b/libs/create-langchain-integration/helpers/default_file_contents.ts
index 1fa3c68231d1..db7df12901cf 100644
--- a/libs/create-langchain-integration/helpers/default_file_contents.ts
+++ b/libs/create-langchain-integration/helpers/default_file_contents.ts
@@ -68,7 +68,7 @@ export const DEFAULT_ESLINTRC = `module.exports = {
 
 export const DEFAULT_README = `# @langchain/<ADD_PACKAGE_NAME_HERE>
 
-This package contains the LangChainJS integrations for <ADD_NAME_HERE> through their SDK.
+This package contains the LangChain.js integrations for <ADD_NAME_HERE> through their SDK.
 
 ## Installation