omarsol commited on
Commit
4f0b574
Β·
1 Parent(s): a7eefa4

Update README with data source management and deployment workflow details

Browse files
Files changed (1) hide show
  1. README.md +17 -2
README.md CHANGED
@@ -13,9 +13,9 @@ pinned: false
13
 
14
  A Gradio UI for the chatbot is available in [scripts/main.py](./scripts/main.py).
15
 
16
- The Gradio demo is deployed on Hugging Face Spaces at: [AI Tutor Chatbot on Hugging Face](https://huggingface.co/spaces/towardsai-buster/ai-tutor-chatbot).
17
 
18
- **Note:** A GitHub Action automatically deploys the Gradio demo when changes are pushed to the `scripts` folder.
19
 
20
  ### Installation (for Gradio UI)
21
 
@@ -72,3 +72,18 @@ The Gradio demo is deployed on Hugging Face Spaces at: [AI Tutor Chatbot on Hugg
72
  ```
73
 
74
  This command starts the Gradio interface for the AI Tutor chatbot.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
  A Gradio UI for the chatbot is available in [scripts/main.py](./scripts/main.py).
15
 
16
+ The Gradio demo is deployed on Hugging Face Spaces at: [AI Tutor Chatbot on Hugging Face](https://huggingface.co/spaces/towardsai-tutors/ai-tutor-chatbot).
17
 
18
+ **Note:** A GitHub Action automatically deploys the Gradio demo when changes are pushed to the main branch (excluding documentation and scripts in the `data/scraping_scripts` directory).
19
 
20
  ### Installation (for Gradio UI)
21
 
 
72
  ```
73
 
74
  This command starts the Gradio interface for the AI Tutor chatbot.
75
+
76
+ ### Updating Data Sources
77
+
78
+ This application uses a RAG (Retrieval Augmented Generation) system with multiple data sources, including documentation and courses. To update these sources:
79
+
80
+ 1. **For adding new courses or updating documentation:**
81
+ - See the detailed instructions in [data/scraping_scripts/README.md](./data/scraping_scripts/README.md)
82
+ - Automated workflows are available for both course addition and documentation updates
83
+
84
+ 2. **Available workflows:**
85
+ - `add_course_workflow.py` - For adding new course content
86
+ - `update_docs_workflow.py` - For updating documentation from GitHub repositories
87
+ - `upload_data_to_hf.py` - For uploading data files to HuggingFace
88
+
89
+ These scripts streamline the process of adding new content to the AI Tutor and ensure consistency across team members.