jerpint commited on
Commit
2c02b68
โ€ข
1 Parent(s): 06a349e

add readme

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: RAGTheDocs
3
+ emoji: ๐Ÿ‘€
4
+ colorFrom: gray
5
+ colorTo: yellow
6
+ sdk: gradio
7
+ sdk_version: 4.0.2
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # RAGtheDocs
14
+
15
+ ## Introduction ๐Ÿ“š
16
+
17
+ RAGTheDocs is an open-source library that allows you to do RAG on any readthedocs documentation using a one-click deploy.
18
+
19
+ ## Features ๐Ÿš€
20
+
21
+ - **Web Scraping and Analysis:** RAGtheDocs automatically scrapes and embeds documentation from any website generated by ReadTheDocs/Sphinx
22
+
23
+ - **RAG Interface:** It comes built-in with a gradio UI for users to interact with the RAG agent
24
+
25
+ - **Customization Options:** Tailor RAGtheDocs to your needs with customizable settings and options.
26
+
27
+
28
+ ## Installation
29
+
30
+ TODO
31
+
32
+ ## Usage
33
+
34
+ TODO
35
+
36
+ ## Configuration
37
+
38
+ TODO