Merge pull request #18 from PetJs/peter/docs

feat:Adding the project structure

CONTRIBUTING.md

@@ -67,6 +67,22 @@ Welcome to the **Speak-To-Docs** project repository, organized by the Microsoft
 
    After pushing your changes, submit a pull request to merge them into the main repository. Make sure to include a clear and concise description of what your contribution entails.
 
+## Project Structure:
+The **Speech-Enabled RAG Solution** is a voice-powered interface that allows users to engage with their documents throuch speech. Look at it as a model that explains a document you want to read.
+
+The project is structured as follows:
+- **speech_to_docs**: This is the main directory for the project.
+- **speech_to_docs/src**: This directory contains all the files that will house all the functionalities of the project: Speech transcription and synthesis, RAG model Solution and document reading..
+- **speech_to_docs/src/rag_functions.py**: This file contains the function that checks for uploaded file compatibility, making sure it doesn't exceed 50 pages limit as well as the RAG model solution functionalities.
+- **speech_to_docs/src/speech_io.py**: This files handles the speech_to_text/ text_to_speech function of the model by using **Azure Cognitive Services: Speech Transcription** (Speech-to-Text) and **Speech Synthesis** (Text-to-Speech).
+- **speech_to_docs/requirements.txt**: This file lists the dependencies required to run the project.
+- **speech_to_docs/README.md**: This file contains information about the project, including this guide
+- **speech_to_docs/LICENSE**: This file contains the license information for the project.
+- **speech_to_docs/CONTRIBUTING.md**: This file contains information about contributing to the project
+- **speech_to_docs/CODE_OF_CONDUCT.md**: This file contains information about the purpose, policy and behaviour expected of the project.
+- **speech_to_docs/LEADERBOARD.md**: This file contains information about the leaderboard (ranking of people with the highest PRs).
+
+
 ## How You Can Contribute:
 
 1. Review the existing project code and issues to understand the functionality.

README.md

@@ -6,7 +6,7 @@ Welcome to the Hacktoberfest Open Source Challenge 2.0 organized by the Microsof
 
 This challenge focuses on two main tracks:
 
-1. **Speech-Enabled RAG Solution**: A project leveraging Microsoft Azure AI Services to build a Retrieval-Augmented Generation (RAG) solution where users can upload any document and interact with it through audio. The system allows for both audio input and audio responses, providing a seamless voice-based interaction with your documents.
+1. **Speech-Enabled RAG Solution**: A project leveraging Microsoft Azure AI Services to build a Retrieval-Augmented Generation (RAG) solution where users can upload any document and interact with it through audio. The system allows for both audio input and audio responses, providing a seamless voice-based interaction with your documents. Want to learn more about the project? Check the [Contribution Guidelines](CONTRIBUTING.md) for insights on what to build.  
 
 2. [**Crime Trend and Fatalities Prediction in Nigeria**](https://github.com/mlsanigeria/nigeria-crime-trends): This project aims to analyze crime trends in Nigeria and build one machine learning model to predict crime-related fatalities. Participants will perform a full analysis of the dataset from [ACLED](https://acleddata.com/), including data cleaning, exploratory data analysis (EDA), and model building. An existing analysis at the Africa level can be used as a reference for participants. You can check out the notebook here for ideas on how to conduct a comprehensive analysis for Nigeria.