Merge pull request #77 from DL4DS/readme_cleanup

README.md

@@ -18,9 +18,12 @@ Hugging Face [Space](https://huggingface.co/spaces/dl4ds/dl4ds_tutor). It is pus
 A "development" version of the Tutor is running live at [DL4DS Tutor -- Dev](https://dl4ds-tutor-dev.hf.space/) from this Hugging Face
 [Space](https://huggingface.co/spaces/dl4ds/tutor_dev). It is pushed automatically from the `dev_branch` branch of this repo by this
 [Actions Workflow](https://github.com/DL4DS/dl4ds_tutor/blob/dev_branch/.github/workflows/push_to_hf_space_prototype.yml) upon a push to `dev_branch`.
-## Running Locally
 
-Please view `docs/setup.md` for more information on setting up the project.
+## Setup
+
+Please visit [setup](https://dl4ds.github.io/dl4ds_tutor/guide/setup/) for more information on setting up the project.
+
+## Running Locally
 
 1. **Clone the Repository**
    ```bash
@@ -49,40 +52,9 @@ Please view `docs/setup.md` for more information on setting up the project.
    chainlit run main.py
    ```
 
-See the [docs](https://github.com/DL4DS/dl4ds_tutor/tree/main/docs) for more information.
-
-## File Structure
-
-```plaintext
-code/
- ├── modules
- │   ├── chat                # Contains the chatbot implementation
- │   ├── chat_processor      # Contains the implementation to process and log the conversations
- │   ├── config              # Contains the configuration files
- │   ├── dataloader          # Contains the implementation to load the data from the storage directory
- │   ├── retriever           # Contains the implementation to create the retriever
- │   └── vectorstore         # Contains the implementation to create the vector database
- ├── public
- │   ├── logo_dark.png       # Dark theme logo
- │   ├── logo_light.png      # Light theme logo
- │   └── test.css            # Custom CSS file
- └── main.py
+## Documentation
 
- 
-docs/                        # Contains the documentation to the codebase and methods used
-
-storage/
- ├── data                    # Store files and URLs here
- ├── logs                    # Logs directory, includes logs on vector DB creation, tutor logs, and chunks logged in JSON files
- └── models                  # Local LLMs are loaded from here
-
-vectorstores/                # Stores the created vector databases
-
-.env                         # This needs to be created, store the API keys here
-```
-- `code/modules/vectorstore/vectorstore.py`: Instantiates the `VectorStore` class to create the vector database.
-- `code/modules/vectorstore/store_manager.py`: Instantiates the `VectorStoreManager:` class to manage the vector database, and all associated methods.
-- `code/modules/retriever/retriever.py`: Instantiates the `Retriever` class to create the retriever.
+Please visit the [docs](https://dl4ds.github.io/dl4ds_tutor/) for more information.
 
 
 ## Docker 
@@ -96,6 +68,10 @@ docker run -it --rm -p 8000:8000 dev
 
 ## Contributing
 
-Please create an issue if you have any suggestions or improvements, and start working on it by creating a branch and by making a pull request to the main branch.
+Please create an issue if you have any suggestions or improvements, and start working on it by creating a branch and by making a pull request to the `dev_branch`.
+
+Please visit [contribute](https://dl4ds.github.io/dl4ds_tutor/guide/contribute/) for more information on contributing.
+
+## Future Work
 
-Please view `docs/contribute.md` for more information on contributing.
+For more information on future work, please visit [roadmap](https://dl4ds.github.io/dl4ds_tutor/guide/readmap/).