ankanghosh commited on
Commit
5265be3
Β·
verified Β·
1 Parent(s): b3cd46b

Update docs/README.md

Browse files
Files changed (1) hide show
  1. docs/README.md +21 -19
docs/README.md CHANGED
@@ -115,24 +115,26 @@ This application is designed for deployment on [Hugging Face Spaces](https://hug
115
 
116
  ```
117
  anveshak/
118
- β”œβ”€β”€ .gitignore # Specifies intentionally untracked files to ignore
119
- β”œβ”€β”€ .gitattributes # Defines attributes for pathnames in the repository
120
- β”œβ”€β”€ app.py # Main Streamlit application
121
- β”œβ”€β”€ requirements.txt # Python dependencies
122
- β”œβ”€β”€ rag_engine.py # Core RAG functionality
123
- β”œβ”€β”€ utils.py # Utility functions for authentication
124
- β”œβ”€β”€ pages/ # Streamlit pages
125
- β”‚ β”œβ”€β”€ 1_Sources.py # Sources information page
126
- β”‚ β”œβ”€β”€ 2_Publishers.py # Publisher acknowledgments page
127
- β”‚ └── 3_Contact_us.py # Contact information page
128
- β”œβ”€β”€ docs/ # Documentation
129
- β”‚ β”œβ”€β”€ architecture-doc.md # Architecture details
130
- β”‚ β”œβ”€β”€ data-handling-doc.md # Data handling explanation
131
- β”‚ β”œβ”€β”€ configuration-doc.md # Configuration guide
132
- β”‚ β”œβ”€β”€ changelog-doc.md # Project change log
133
- β”‚ └── README.md # Project overview and instructions
134
- └── scripts/ # Data processing scripts
135
- └── preprocessing.ipynb # Text preprocessing notebook
 
 
136
  ```
137
 
138
  ## πŸ”’ Data Privacy & Ethics
@@ -203,4 +205,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](../LIC
203
 
204
  ## πŸ“ž Contact
205
 
206
- For questions, feedback, or suggestions, please contact us at [email protected].
 
115
 
116
  ```
117
  anveshak/
118
+ β”œβ”€β”€ .gitignore # Specifies intentionally untracked files to ignore
119
+ β”œβ”€β”€ .gitattributes # Defines attributes for pathnames in the repository
120
+ β”œβ”€β”€ app.py # Main Streamlit application
121
+ β”œβ”€β”€ requirements.txt # Python dependencies
122
+ β”œβ”€β”€ rag_engine.py # Core RAG functionality
123
+ β”œβ”€β”€ utils.py # Utility functions for authentication
124
+ β”œβ”€β”€ pages/ # Streamlit pages
125
+ β”‚ β”œβ”€β”€ 1_Sources.py # Sources information page
126
+ β”‚ β”œβ”€β”€ 2_Publishers.py # Publisher acknowledgments page
127
+ β”‚ └── 3_Contact_us.py # Contact information page
128
+ β”œβ”€β”€ docs/ # Documentation
129
+ β”‚ └── assets/ # Images and other media
130
+ β”‚ └── app_screenshot.png # Application screenshot
131
+ β”‚ β”œβ”€β”€ architecture-doc.md # Architecture details
132
+ β”‚ β”œβ”€β”€ data-handling-doc.md # Data handling explanation
133
+ β”‚ β”œβ”€β”€ configuration-doc.md # Configuration guide
134
+ β”‚ β”œβ”€β”€ changelog-doc.md # Project change log
135
+ β”‚ β”œβ”€β”€ README.md # Project overview and instructions
136
+ └── scripts/ # Data processing scripts
137
+ └── preprocessing.ipynb # Text preprocessing notebook
138
  ```
139
 
140
  ## πŸ”’ Data Privacy & Ethics
 
205
 
206
  ## πŸ“ž Contact
207
 
208
+ For questions, feedback, or suggestions, please contact us at [email protected].