From 54f43215cd972cd4f3f3099d29d4115b00e1aa40 Mon Sep 17 00:00:00 2001
From: Sidharth Mohanty <sidmohanty11@gmail.com>
Date: Sat, 16 Dec 2023 07:59:05 +0530
Subject: [PATCH] Docs for directory data loader usage (#1016)

---
 docs/components/data-sources/directory.mdx | 41 ++++++++++++++++++++++
 docs/components/data-sources/overview.mdx  |  1 +
 docs/mint.json                             |  3 +-
 3 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 docs/components/data-sources/directory.mdx

diff --git a/docs/components/data-sources/directory.mdx b/docs/components/data-sources/directory.mdx
new file mode 100644
index 000000000..f37e373ed
--- /dev/null
+++ b/docs/components/data-sources/directory.mdx
@@ -0,0 +1,41 @@
+---
+title: '📁 Directory'
+---
+
+To use an entire directory as data source, just add `data_type` as `directory` and pass in the path of the local directory.
+
+### Without customization
+
+```python
+import os
+from embedchain import Pipeline as App
+
+os.environ["OPENAI_API_KEY"] = "sk-xxx"
+
+app = App()
+app.add("./elon-musk", data_type="directory")
+response = app.query("list all files")
+print(response)
+# Answer: Files are elon-musk-1.txt, elon-musk-2.pdf.
+```
+
+### Customization
+
+```python
+import os
+from embedchain import Pipeline as App
+from embedchain.loaders.directory_loader import DirectoryLoader
+
+os.environ["OPENAI_API_KEY"] = "sk-xxx"
+lconfig = {
+    "recursive": True,
+    "extensions": [".txt"]
+}
+loader = DirectoryLoader(config=lconfig)
+app = App()
+app.add("./elon-musk", loader=loader)
+response = app.query("what are all the files related to?")
+print(response)
+
+# Answer: The files are related to Elon Musk.
+```
diff --git a/docs/components/data-sources/overview.mdx b/docs/components/data-sources/overview.mdx
index ec9ecade7..515f864c9 100644
--- a/docs/components/data-sources/overview.mdx
+++ b/docs/components/data-sources/overview.mdx
@@ -29,6 +29,7 @@ Embedchain comes with built-in support for various data sources. We handle the c
   <Card title="⚙️ Custom" href="/components/data-sources/custom"></Card>
   <Card title="📝 Substack" href="/components/data-sources/substack"></Card>
   <Card title="🐝 Beehiiv" href="/components/data-sources/beehiiv"></Card>
+  <Card title="📁 Directory" href="/components/data-sources/directory"></Card>
 </CardGroup>
 
 <br/ >
diff --git a/docs/mint.json b/docs/mint.json
index 257a73bcf..9e21810e5 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -116,7 +116,8 @@
                 "components/data-sources/discourse",
                 "components/data-sources/substack",
                 "components/data-sources/discord",
-                "components/data-sources/beehiiv"
+                "components/data-sources/beehiiv",
+                "components/data-sources/directory"
               ]
             },
             "components/data-sources/data-type-handling"