Skip to content

Commit dc80ce4

Browse files
mrlynnmrlynn
committed
add docs
1 parent 3af809c commit dc80ce4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+3561
-0
lines changed

‎mongodb-rag-docs/.aidigestignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
build
2+
node_modules
3+
dist
4+
.docusaurus

‎mongodb-rag-docs/.docusaurus/DONT-EDIT-THIS-FOLDER‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This folder stores temp files that Docusaurus' client bundler accesses.
2+
3+
DO NOT hand-modify files in this folder because they will be overwritten in the
4+
next build. You can clear all build artifacts (including this folder) with the
5+
`docusaurus clear` command.

‎mongodb-rag-docs/.docusaurus/client-manifest.json‎

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
{
2+
"entrypoints": [
3+
"main"
4+
],
5+
"origins": {
6+
"42": [
7+
42
8+
],
9+
"17896441": [
10+
869,
11+
401
12+
],
13+
"main": [
14+
354,
15+
869,
16+
792
17+
],
18+
"runtime~main": [
19+
792,
20+
869,
21+
354
22+
],
23+
"0e384e19": [
24+
976
25+
],
26+
"16f9b06f": [
27+
811
28+
],
29+
"3b8c55ea": [
30+
803
31+
],
32+
"5e95c892": [
33+
647
34+
],
35+
"6476eba6": [
36+
722
37+
],
38+
"72d756b8": [
39+
256
40+
],
41+
"76391b45": [
42+
448
43+
],
44+
"964ae018": [
45+
443
46+
],
47+
"a7456010": [
48+
235
49+
],
50+
"a7bd4aaa": [
51+
98
52+
],
53+
"a94703ab": [
54+
869,
55+
48
56+
],
57+
"aba21aa0": [
58+
742
59+
],
60+
"b4a7054a": [
61+
129
62+
],
63+
"c4f5d8e4": [
64+
869,
65+
634
66+
],
67+
"styles": [
68+
48,
69+
354,
70+
401,
71+
634,
72+
792,
73+
869
74+
]
75+
},
76+
"assets": {
77+
"42": {
78+
"js": [
79+
{
80+
"file": "assets/js/42.2006a03a.js",
81+
"hash": "4d0dbb459ca3481f",
82+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/42.2006a03a.js"
83+
}
84+
]
85+
},
86+
"48": {
87+
"js": [
88+
{
89+
"file": "assets/js/a94703ab.198af767.js",
90+
"hash": "1e81fd91d2c9c2ca",
91+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/a94703ab.198af767.js"
92+
}
93+
]
94+
},
95+
"98": {
96+
"js": [
97+
{
98+
"file": "assets/js/a7bd4aaa.207e9845.js",
99+
"hash": "2203e2bf6b5d0116",
100+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/a7bd4aaa.207e9845.js"
101+
}
102+
]
103+
},
104+
"129": {
105+
"js": [
106+
{
107+
"file": "assets/js/b4a7054a.a1c8ea57.js",
108+
"hash": "64991d2621a192b7",
109+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/b4a7054a.a1c8ea57.js"
110+
}
111+
]
112+
},
113+
"235": {
114+
"js": [
115+
{
116+
"file": "assets/js/a7456010.51b3a2be.js",
117+
"hash": "4726af5ab5ec3022",
118+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/a7456010.51b3a2be.js"
119+
}
120+
]
121+
},
122+
"256": {
123+
"js": [
124+
{
125+
"file": "assets/js/72d756b8.c7e1bef7.js",
126+
"hash": "0897fa7a3483d8f2",
127+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/72d756b8.c7e1bef7.js"
128+
}
129+
]
130+
},
131+
"354": {
132+
"js": [
133+
{
134+
"file": "assets/js/runtime~main.afefdb30.js",
135+
"hash": "2d0f6f461fa99480",
136+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/runtime~main.afefdb30.js"
137+
}
138+
]
139+
},
140+
"401": {
141+
"js": [
142+
{
143+
"file": "assets/js/17896441.4863802f.js",
144+
"hash": "223d02e4ab9cc5b8",
145+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/17896441.4863802f.js"
146+
}
147+
]
148+
},
149+
"443": {
150+
"js": [
151+
{
152+
"file": "assets/js/964ae018.8c16016e.js",
153+
"hash": "cfa4bdc241533e14",
154+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/964ae018.8c16016e.js"
155+
}
156+
]
157+
},
158+
"448": {
159+
"js": [
160+
{
161+
"file": "assets/js/76391b45.a3329432.js",
162+
"hash": "2dcee432e3cae569",
163+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/76391b45.a3329432.js"
164+
}
165+
]
166+
},
167+
"634": {
168+
"js": [
169+
{
170+
"file": "assets/js/c4f5d8e4.29b1a43e.js",
171+
"hash": "db5de4cb7b10ed9f",
172+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/c4f5d8e4.29b1a43e.js"
173+
}
174+
]
175+
},
176+
"647": {
177+
"js": [
178+
{
179+
"file": "assets/js/5e95c892.90e324ea.js",
180+
"hash": "778e61c3b15d4363",
181+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/5e95c892.90e324ea.js"
182+
}
183+
]
184+
},
185+
"722": {
186+
"js": [
187+
{
188+
"file": "assets/js/6476eba6.115cc1d9.js",
189+
"hash": "c2ba5e02bbb837b6",
190+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/6476eba6.115cc1d9.js"
191+
}
192+
]
193+
},
194+
"742": {
195+
"js": [
196+
{
197+
"file": "assets/js/aba21aa0.1a3087e5.js",
198+
"hash": "ba887585389ba5be",
199+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/aba21aa0.1a3087e5.js"
200+
}
201+
]
202+
},
203+
"792": {
204+
"js": [
205+
{
206+
"file": "assets/js/main.6d3dec77.js",
207+
"hash": "317b024040911614",
208+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/main.6d3dec77.js"
209+
}
210+
]
211+
},
212+
"803": {
213+
"js": [
214+
{
215+
"file": "assets/js/3b8c55ea.6f3753f8.js",
216+
"hash": "11dc0fec6e1446b2",
217+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/3b8c55ea.6f3753f8.js"
218+
}
219+
]
220+
},
221+
"811": {
222+
"js": [
223+
{
224+
"file": "assets/js/16f9b06f.8fea0613.js",
225+
"hash": "e640f14cc178be5d",
226+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/16f9b06f.8fea0613.js"
227+
}
228+
]
229+
},
230+
"869": {
231+
"css": [
232+
{
233+
"file": "assets/css/styles.f0e0ecf4.css",
234+
"hash": "0da7aaf5eb086373",
235+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/css/styles.f0e0ecf4.css"
236+
}
237+
]
238+
},
239+
"976": {
240+
"js": [
241+
{
242+
"file": "assets/js/0e384e19.fd66f458.js",
243+
"hash": "53d31e34ca2ef696",
244+
"publicPath": "/mongodb-rag/mongodb-rag-docs/assets/js/0e384e19.fd66f458.js"
245+
}
246+
]
247+
}
248+
}
249+
}

‎mongodb-rag-docs/.docusaurus/client-modules.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
export default [
2+
require("/Users/michael.lynn/code/mongodb-rag/mongodb-rag-docs/node_modules/infima/dist/css/default/default.css"),
3+
require("/Users/michael.lynn/code/mongodb-rag/mongodb-rag-docs/node_modules/@docusaurus/theme-classic/lib/prism-include-languages"),
4+
require("/Users/michael.lynn/code/mongodb-rag/mongodb-rag-docs/node_modules/@docusaurus/theme-classic/lib/nprogress"),
5+
require("/Users/michael.lynn/code/mongodb-rag/mongodb-rag-docs/src/css/custom.css"),
6+
];

‎mongodb-rag-docs/.docusaurus/codeTranslations.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎mongodb-rag-docs/.docusaurus/docusaurus-plugin-content-docs/default/__plugin.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "docusaurus-plugin-content-docs",
3+
"id": "default"
4+
}

‎mongodb-rag-docs/.docusaurus/docusaurus-plugin-content-docs/default/p/mongodb-rag-mongodb-rag-docs-docs-69a.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"link","label":"Introduction","href":"/mongodb-rag/mongodb-rag-docs/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"Installation","href":"/mongodb-rag/mongodb-rag-docs/docs/installation","docId":"installation","unlisted":false},{"type":"link","label":"Usage","href":"/mongodb-rag/mongodb-rag-docs/docs/usage","docId":"usage","unlisted":false},{"type":"category","label":"Examples","collapsed":false,"items":[{"type":"link","label":"Basic Example","href":"/mongodb-rag/mongodb-rag-docs/docs/examples/basic-example","docId":"examples/basic-example","unlisted":false},{"type":"link","label":"Advanced Example","href":"/mongodb-rag/mongodb-rag-docs/docs/examples/advanced-example","docId":"examples/advanced-example","unlisted":false}],"collapsible":true},{"type":"link","label":"API Reference","href":"/mongodb-rag/mongodb-rag-docs/docs/api-reference","docId":"api-reference","unlisted":false}]},"docs":{"api-reference":{"id":"api-reference","title":"API Reference","description":"MongoRAG Class","sidebar":"docs"},"examples/advanced-example":{"id":"examples/advanced-example","title":"Advanced Example","description":"This example demonstrates advanced features of MongoDB-RAG, including custom preprocessing, metadata filtering, and integration with an LLM for question answering.","sidebar":"docs"},"examples/basic-example":{"id":"examples/basic-example","title":"Basic Example","description":"This example demonstrates how to set up a simple RAG system using MongoDB-RAG for document retrieval and question answering.","sidebar":"docs"},"installation":{"id":"installation","title":"Installation","description":"Install via npm","sidebar":"docs"},"intro":{"id":"intro","title":"Introduction","description":"MongoDB-RAG is a library designed to integrate Retrieval-Augmented Generation (RAG) with MongoDB Atlas Vector Search.","sidebar":"docs"},"usage":{"id":"usage","title":"Usage","description":"Importing MongoRAG","sidebar":"docs"}}}}

‎mongodb-rag-docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-api-reference-md-964.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"id": "api-reference",
3+
"title": "API Reference",
4+
"description": "MongoRAG Class",
5+
"source": "@site/docs/api-reference.md",
6+
"sourceDirName": ".",
7+
"slug": "/api-reference",
8+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/api-reference",
9+
"draft": false,
10+
"unlisted": false,
11+
"editUrl": "https://github.com/mongodb-developer/mongodb-rag/tree/main/mongodb-rag-docs/docs/api-reference.md",
12+
"tags": [],
13+
"version": "current",
14+
"sidebarPosition": 5,
15+
"frontMatter": {
16+
"id": "api-reference",
17+
"title": "API Reference",
18+
"sidebar_position": 5
19+
},
20+
"sidebar": "docs",
21+
"previous": {
22+
"title": "Advanced Example",
23+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/examples/advanced-example"
24+
}
25+
}

‎mongodb-rag-docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-examples-advanced-example-md-16f.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"id": "examples/advanced-example",
3+
"title": "Advanced Example",
4+
"description": "This example demonstrates advanced features of MongoDB-RAG, including custom preprocessing, metadata filtering, and integration with an LLM for question answering.",
5+
"source": "@site/docs/examples/advanced-example.md",
6+
"sourceDirName": "examples",
7+
"slug": "/examples/advanced-example",
8+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/examples/advanced-example",
9+
"draft": false,
10+
"unlisted": false,
11+
"editUrl": "https://github.com/mongodb-developer/mongodb-rag/tree/main/mongodb-rag-docs/docs/examples/advanced-example.md",
12+
"tags": [],
13+
"version": "current",
14+
"sidebarPosition": 2,
15+
"frontMatter": {
16+
"id": "advanced-example",
17+
"title": "Advanced Example",
18+
"sidebar_position": 2
19+
},
20+
"sidebar": "docs",
21+
"previous": {
22+
"title": "Basic Example",
23+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/examples/basic-example"
24+
},
25+
"next": {
26+
"title": "API Reference",
27+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/api-reference"
28+
}
29+
}

‎mongodb-rag-docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-examples-basic-example-md-b4a.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"id": "examples/basic-example",
3+
"title": "Basic Example",
4+
"description": "This example demonstrates how to set up a simple RAG system using MongoDB-RAG for document retrieval and question answering.",
5+
"source": "@site/docs/examples/basic-example.md",
6+
"sourceDirName": "examples",
7+
"slug": "/examples/basic-example",
8+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/examples/basic-example",
9+
"draft": false,
10+
"unlisted": false,
11+
"editUrl": "https://github.com/mongodb-developer/mongodb-rag/tree/main/mongodb-rag-docs/docs/examples/basic-example.md",
12+
"tags": [],
13+
"version": "current",
14+
"sidebarPosition": 1,
15+
"frontMatter": {
16+
"id": "basic-example",
17+
"title": "Basic Example",
18+
"sidebar_position": 1
19+
},
20+
"sidebar": "docs",
21+
"previous": {
22+
"title": "Usage",
23+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/usage"
24+
},
25+
"next": {
26+
"title": "Advanced Example",
27+
"permalink": "/mongodb-rag/mongodb-rag-docs/docs/examples/advanced-example"
28+
}
29+
}

0 commit comments

Comments
 (0)