Add redirects

malandis · Jul 17, 2023 · a156146 · a156146
1 parent c934332
commit a156146
Show file tree

Hide file tree

Showing 19 changed files with 347 additions and 5 deletions.
diff --git a/docs/local_build.sh → docs/build.sh b/docs/local_build.sh → docs/build.sh
diff --git a/.../modules/memory/examples/buffer_memory.md → ...ules/memory/integrations/buffer_memory.md b/.../modules/memory/examples/buffer_memory.md → ...ules/memory/integrations/buffer_memory.md
diff --git a/...es/memory/examples/buffer_memory_chat.mdx → ...emory/integrations/buffer_memory_chat.mdx b/...es/memory/examples/buffer_memory_chat.mdx → ...emory/integrations/buffer_memory_chat.mdx
diff --git a/...s/memory/examples/buffer_window_memory.md → ...mory/integrations/buffer_window_memory.md b/...s/memory/examples/buffer_window_memory.md → ...mory/integrations/buffer_window_memory.md
diff --git a/.../memory/examples/conversation_summary.mdx → ...ory/integrations/conversation_summary.mdx b/.../memory/examples/conversation_summary.mdx → ...ory/integrations/conversation_summary.mdx
diff --git a/...tras/modules/memory/examples/dynamodb.mdx → .../modules/memory/integrations/dynamodb.mdx b/...tras/modules/memory/examples/dynamodb.mdx → .../modules/memory/integrations/dynamodb.mdx
diff --git a/...modules/memory/examples/entity_memory.mdx → ...les/memory/integrations/entity_memory.mdx b/...modules/memory/examples/entity_memory.mdx → ...les/memory/integrations/entity_memory.mdx
diff --git a/.../extras/modules/memory/examples/index.mdx → ...ras/modules/memory/integrations/index.mdx b/.../extras/modules/memory/examples/index.mdx → ...ras/modules/memory/integrations/index.mdx
diff --git a/...xtras/modules/memory/examples/momento.mdx → ...s/modules/memory/integrations/momento.mdx b/...xtras/modules/memory/examples/momento.mdx → ...s/modules/memory/integrations/momento.mdx
diff --git a/...ules/memory/examples/motorhead_memory.mdx → .../memory/integrations/motorhead_memory.mdx b/...ules/memory/examples/motorhead_memory.mdx → .../memory/integrations/motorhead_memory.mdx
diff --git a/.../extras/modules/memory/examples/redis.mdx → ...ras/modules/memory/integrations/redis.mdx b/.../extras/modules/memory/examples/redis.mdx → ...ras/modules/memory/integrations/redis.mdx
diff --git a/...modules/memory/examples/upstash_redis.mdx → ...les/memory/integrations/upstash_redis.mdx b/...modules/memory/examples/upstash_redis.mdx → ...les/memory/integrations/upstash_redis.mdx
diff --git a/...s/memory/examples/vector_store_memory.mdx → ...mory/integrations/vector_store_memory.mdx b/...s/memory/examples/vector_store_memory.mdx → ...mory/integrations/vector_store_memory.mdx
diff --git a/...as/modules/memory/examples/zep_memory.mdx → ...odules/memory/integrations/zep_memory.mdx b/...as/modules/memory/examples/zep_memory.mdx → ...odules/memory/integrations/zep_memory.mdx
diff --git a/docs/compile_docs.sh → docs/nodemon.sh b/docs/compile_docs.sh → docs/nodemon.sh
diff --git a/docs/package.json b/docs/package.json
@@ -3,8 +3,8 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "bash ./local_build.sh",
-    "dev": "yarn build & nodemon -e mdx,md --exec \"bash\" ./compile_docs.sh & wait"
+    "build": "bash ./build.sh",
+    "dev": "yarn build & nodemon -e mdx,md --exec \"bash\" ./nodemon.sh & wait"
   },
   "devDependencies": {
     "nodemon": "^3.0.1"

diff --git a/docs/snippets/get_started/introduction.mdx b/docs/snippets/get_started/introduction.mdx
@@ -1,5 +1,3 @@
-# Introduction
-
 **LangChain** is a framework for developing applications powered by language models. It enables applications that are:
 - **Data-aware**: connect a language model to other sources of data
 - **Agentic**: allow a language model to interact with its environment

diff --git a/docs/vercel.json b/docs/vercel.json
@@ -0,0 +1,344 @@
+{
+  "redirects": [
+    {
+      "source": "/docs",
+      "destination": "/docs/get_started/introduction"
+    },
+    {
+      "source": "/docs/getting-started/install",
+      "destination": "/docs/get_started/installation"
+    },
+    {
+      "source": "/docs/getting-started/guide-llm",
+      "destination": "/docs/get_started/quickstart"
+    },
+    {
+      "source": "/docs/getting-started/guide-chat",
+      "destination": "/docs/get_started/quickstart"
+    },
+    {
+      "source": "/docs/modules/schema/:path*",
+      "destination": "/docs/get_started/quickstart"
+    },
+    {
+      "source": "/docs/modules/models",
+      "destination": "/docs/modules/model_io/models"
+    },
+    {
+      "source": "/docs/modules/models/chat",
+      "destination": "/docs/modules/model_io/models/chat"
+    },
+    {
+      "source": "/docs/modules/models/chat/integrations",
+      "destination": "/docs/modules/model_io/models/chat"
+    },
+    {
+      "source": "/docs/modules/models/chat/additional_functionality",
+      "destination": "/docs/modules/model_io/models/chat"
+    },
+    {
+      "source": "/docs/modules/models/embeddings",
+      "destination": "/docs/modules/data_connection/text_embedding"
+    },
+    {
+      "source": "/docs/modules/models/embeddings/integrations",
+      "destination": "/docs/modules/data_connection/text_embedding"
+    },
+    {
+      "source": "/docs/modules/models/embeddings/additional_functionality",
+      "destination": "/docs/modules/data_connection/text_embedding"
+    },
+    {
+      "source": "/docs/modules/models/llms",
+      "destination": "/docs/modules/model_io/models/llms"
+    },
+    {
+      "source": "/docs/modules/models/llms/integrations",
+      "destination": "/docs/modules/model_io/models/llms"
+    },
+    {
+      "source": "/docs/modules/models/llms/additional_functionality",
+      "destination": "/docs/modules/model_io/models/llms"
+    },
+    {
+      "source": "/docs/modules/prompts",
+      "destination": "/docs/modules/model_io/prompts"
+    },
+    {
+      "source": "/docs/modules/prompts/prompt_templates",
+      "destination": "/docs/modules/model_io/prompts/prompt_templates"
+    },
+    {
+      "source": "/docs/modules/prompts/prompt_templates/prompt_composition",
+      "destination": "/docs/modules/model_io/prompts/prompt_templates/prompt_composition"
+    },
+    {
+      "source": "/docs/modules/prompts/prompt_templates/additional_functionality",
+      "destination": "/docs/modules/model_io/prompts/prompt_templates"
+    },
+    {
+      "source": "/docs/modules/prompts/output_parsers",
+      "destination": "/docs/modules/model_io/output_parsers"
+    },
+    {
+      "source": "/docs/modules/prompts/example_selectors",
+      "destination": "/docs/modules/model_io/prompts/example_selectors"
+    },
+    {
+      "source": "/docs/modules/indexes",
+      "destination": "/docs/modules/data_connection"
+    },
+    {
+      "source": "/docs/modules/indexes/document_loaders",
+      "destination": "/docs/modules/data_connection/document_loaders"
+    },
+    {
+      "source": "/docs/modules/indexes/document_loaders/examples",
+      "destination": "/docs/modules/data_connection/document_loaders"
+    },
+    {
+      "source": "/docs/modules/indexes/document_loaders/examples/file_loaders/:path*",
+      "destination": "docs/modules/data_connection/document_loaders/integrations/file_loaders/:path*"
+    },
+    {
+      "source": "/docs/modules/indexes/document_loaders/examples/web_loaders/:path*",
+      "destination": "/docs/modules/data_connection/document_loaders/integrations/web_loaders/:path*"
+    },
+    {
+      "source": "/docs/modules/indexes/document_transformers",
+      "destination": "/docs/modules/data_connection/document_transformers"
+    },
+    {
+      "source": "/docs/modules/indexes/text_splitters",
+      "destination": "/docs/modules/data_connection/document_transformers"
+    },
+    {
+      "source": "/docs/modules/indexes/text_splitters/examples/:path*",
+      "destination": "/docs/modules/data_connection/document_transformers/text_splitters/:path*"
+    },
+    {
+      "source": "/docs/modules/indexes/vector_stores",
+      "destination": "/docs/modules/data_connection/vectorstores"
+    },
+    {
+      "source": "/docs/modules/indexes/vector_stores/integrations/:path*",
+      "destination": "/docs/modules/data_connection/vectorstores/integrations/:path*"
+    },
+    {
+      "source": "/docs/modules/indexes/retrievers",
+      "destination": "/docs/modules/data_connection/retrievers"
+    },
+    {
+      "source": "/docs/modules/indexes/retrievers/self_query",
+      "destination": "/docs/modules/data_connection/retrievers/how_to/self_query/"
+    },
+    {
+      "source": "/docs/modules/indexes/retrievers/self_query/examples/:path*",
+      "destination": "/docs/modules/data_connection/retrievers/how_to/self_query/:path*"
+    },
+    {
+      "source": "/docs/modules/indexes/retrievers/:path*",
+      "destination": "/docs/modules/data_connection/retrievers/integrations/:path*"
+    },
+    {
+      "source": "/docs/modules/memory/examples/:path*",
+      "destination": "/docs/modules/memory/integrations/:path*"
+    },
+    {
+      "source": "/docs/modules/chains/llm_chain",
+      "destination": "/docs/modules/chains/foundational/llm_chain"
+    },
+    {
+      "source": "/docs/modules/chains/index_related_chains",
+      "destination": "/docs/modules/chains/document"
+    },
+    {
+      "source": "/docs/modules/chains/index_related_chains/document_qa",
+      "destination": "/docs/modules/chains/document"
+    },
+    {
+      "source": "/docs/modules/chains/index_related_chains/retrieval_qa",
+      "destination": "docs/modules/chains/popular/vector_db_qa"
+    },
+    {
+      "source": "/docs/modules/chains/index_related_chains/conversational_retrieval",
+      "destination": "/docs/modules/chains/popular/chat_vector_db"
+    },
+    {
+      "source": "/docs/modules/chains/sequential_chain",
+      "destination": "/docs/modules/chains/foundational/sequential_chains"
+    },
+    {
+      "source": "/docs/modules/chains/openai_functions",
+      "destination": "/docs/modules/chains/additional/openai_functions"
+    },
+    {
+      "source": "/docs/modules/chains/openai_functions/extraction",
+      "destination": "/docs/modules/chains/additional/openai_functions/extraction"
+    },
+    {
+      "source": "/docs/modules/chains/openai_functions/openapi",
+      "destination": "/docs/modules/chains/additional/openai_functions/openapi"
+    },
+    {
+      "source": "/docs/modules/chains/openai_functions/structured_output",
+      "destination": "/docs/modules/chains/popular/structured_output"
+    },
+    {
+      "source": "/docs/modules/chains/openai_functions/tagging",
+      "destination": "/docs/modules/chains/additional/openai_functions/tagging"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains",
+      "destination": "/docs/modules/chains/additional"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/analyze_document",
+      "destination": "/docs/modules/chains/additional/analyze_document"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/api_chain",
+      "destination": "/docs/modules/chains/popular/api"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/constitutional_chain",
+      "destination": "/docs/modules/chains/additional/constitutional_chain"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/moderation_chain",
+      "destination": "/docs/modules/chains/additional/moderation"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/multi_prompt_chain",
+      "destination": "/docs/modules/chains/additional/multi_prompt_router"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/multi_retrieval_qa_chain",
+      "destination": "/docs/modules/chains/additional/multi_retrieval_qa_router"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/sql",
+      "destination": "/docs/modules/chains/popular/sqlite"
+    },
+    {
+      "source": "/docs/modules/chains/other_chains/summarization",
+      "destination": "/docs/modules/chains/popular/summarize"
+    },
+    {
+      "source": "/docs/modules/chains/prompt_selectors",
+      "destination": "/docs/modules/model_io/prompts/prompt_selectors"
+    },
+    {
+      "source": "/docs/modules/agents/agents",
+      "destination": "/docs/modules/agents"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action",
+      "destination": "/docs/modules/agents"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action/llm_mrkl",
+      "destination": "/docs/modules/agents/agent_types/react"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action/chat_mrkl",
+      "destination": "/docs/modules/agents/agent_types/react"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action/conversational_agent",
+      "destination": "/docs/modules/agents/agent_types/chat_conversation_agent"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action/structured_chat",
+      "destination": "/docs/modules/agents/agent_types/structured_chat"
+    },
+    {
+      "source": "/docs/modules/agents/agents/action/openai",
+      "destination": "/docs/modules/agents/agent_types/openai_functions_agent"
+    },
+    {
+      "source": "docs/modules/agents/agents/plan_execute",
+      "destination": "/docs/modules/agents/agent_types/plan_and_execute"
+    },
+    {
+      "source": "/docs/modules/agents/agents/custom",
+      "destination": "/docs/modules/agents/how_to/custom_llm_agent"
+    },
+    {
+      "source": "/docs/modules/agents/agents/custom/custom_prompt_chat",
+      "destination": "/docs/modules/agents/how_to/custom_llm_chat_agent"
+    },
+    {
+      "source": "/docs/modules/agents/agents/custom/custom_agent_chat",
+      "destination": "/docs/modules/agents/how_to/custom_llm_chat_agent"
+    },
+    {
+      "source": "/docs/modules/agents/agents/custom/custom_agent_llm",
+      "destination": "/docs/modules/agents/how_to/custom_llm_agent"
+    },
+    {
+      "source": "/docs/modules/agents/executor",
+      "destination": "/docs/modules/agents"
+    },
+    {
+      "source": "/docs/modules/agents/executor/getting-started",
+      "destination": "/docs/modules/agents"
+    },
+    {
+      "source": "/docs/modules/agents/tools/integrations",
+      "destination": "/docs/modules/agents/tools/integrations"
+    },
+    {
+      "source": "/docs/modules/agents/tools/agents_with_vectorstores",
+      "destination": "/docs/modules/agents/tools/how_to/agents_with_vectorstores"
+    },
+    {
+      "source": "/docs/modules/agents/tools/aiplugin-tool",
+      "destination": "/docs/modules/agents/tools/integrations/aiplugin-tool"
+    },
+    {
+      "source": "/docs/modules/agents/tools/dynamic",
+      "destination": "/docs/modules/agents/tools/how_to/dynamic"
+    },
+    {
+      "source": "/docs/modules/agents/tools/lambda_agent",
+      "destination": "/docs/modules/agents/tools/integrations/lambda_agent"
+    },
+    {
+      "source": "/docs/modules/agents/tools/webbrowser",
+      "destination": "/docs/modules/agents/tools/integrations/webbrowser"
+    },
+    {
+      "source": "/docs/modules/agents/tools/zapier_agent",
+      "destination": "/docs/modules/agents/tools/integrations/zapier_agent"
+    },
+    {
+      "source": "/docs/modules/agents/additional_functionality",
+      "destination": "/docs/modules/agents"
+    },
+    {
+      "source": "/docs/production/callbacks",
+      "destination": "/docs/modules/callbacks"
+    },
+    {
+      "source": "/docs/production/callbacks/create-handlers",
+      "destination": "/docs/modules/callbacks/how_to/create_handlers"
+    },
+    {
+      "source": "/docs/production/callbacks/creating-subclasses",
+      "destination": "/docs/modules/callbacks/how_to/creating_subclasses"
+    },
+    {
+      "source": "/docs/production/deployment",
+      "destination": "/docs/get_started/introduction"
+    },
+    {
+      "source": "/docs/production/tracing",
+      "destination": "TODO: LangSmith"
+    },
+    {
+      "source": "/docs/ecosystem/:path*",
+      "destination": "/docs/ecosystem/integrations/:path*"
+    }
+  ]
+}
diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
     "publish": "bash scripts/release-branch.sh && turbo run --filter langchain build lint test && yarn run test:exports:docker && yarn workspace langchain run release && echo '🔗 Open https://github.com/hwchase17/langchainjs/compare/release?expand=1 and merge the release PR'",
     "example": "yarn workspace examples start",
     "precommit": "turbo run precommit",
-    "docs": "yarn workspace docs start",
+    "docs": "yarn workspace docs dev",
     "postinstall": "husky install"
   },
   "author": "LangChain",