run docs only when docs is modified

philippemiron · Jul 1, 2024 · 83c1c47 · 83c1c47
1 parent 2a2371d
commit 83c1c47
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -3,6 +3,12 @@ name: Docs
 on:
   push:
     branches: [ main ]
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

diff --git a/README.md b/README.md
@@ -11,6 +11,6 @@ To run the image, you have to map port `8501` to a local port and set the `GEMIN
 ```
 docker run -p 8501:8501 -e GEMINI_API_TOKEN=$GEMINI_API_KEY pmiron/alice-rag-llm:latest
 ```
-will launch a Streamlit application locally, i.e. at [http://0.0.0.0:8501](http://0.0.0.0:8501). 
+will launch a Streamlit application locally, i.e. at [http://0.0.0.0:8501](http://0.0.0.0:8501). Below a screenshot of an interaction with the application.
 
 ![screnshot-alicerage](img/alicerag.png)