doc: improve documentation

inclusive-design · Jul 10, 2024 · e05168c · e05168c
1 parent daf18dd
commit e05168c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ git clone https://github.com/your-username/baby-bliss-bot
 cd baby-bliss-bot
 ```
 
-### Create/Activitate Virtual Environment
+### Create/Activiate Virtual Environment
 Always activate and use the python virtual environment to maintain an isolated environment for project's dependencies.
 
 * [Create the virtual environment](https://docs.python.org/3/library/venv.html)

diff --git a/docs/RAG.md b/docs/RAG.md
@@ -38,6 +38,8 @@ the python script.
   1. Select a Model
     - Choose a [sentence transformer model](https://huggingface.co/sentence-transformers) from Hugging Face.
   2. Download the Model
+    - Make sure that your system has the git-lfs command installed. See 
+    [Git Large File Storage](https://git-lfs.com/) for instructions.
     - Download the selected model to a local directory. For example, to download the 
     [`all-MiniLM-L6-v2` model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2), use the following
     command:
@@ -49,7 +51,7 @@ the python script.
   **Note:** Accessing a local sentence transformer model is much faster than accessing it via the
   `sentence-transformers` Python package.
 
-### Create/Activitate Virtual Environment
+### Create/Activiate Virtual Environment
 * Go to the RAG scripts directory
   - `cd jobs/RAG`
 

diff --git a/docs/ReflectChatHistory.md b/docs/ReflectChatHistory.md
@@ -55,7 +55,7 @@ The converted sentences are more accurate and appropriate compared to those gene
   install and run Ollama on a local computer.
 * If you are currently in a activated virtual environment, deactivate it.
 
-### Create/Activitate Virtual Environment
+### Create/Activiate Virtual Environment
 * Go to the RAG scripts directory
   - `cd jobs/RAG`