docs: update workflow documentation

yangwu1227 · Sep 17, 2024 · f9d8f30 · f9d8f30
1 parent 1a73659
commit f9d8f30
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
@@ -4,8 +4,8 @@ on:
     branches:
       - main
     paths:
-        - docs/**
-        - mkdocs.yml
+        - project/docs/**
+        - project/mkdocs.yml
         - .github/workflows/deploy_docs.yml
 
 permissions:

diff --git a/project/docs/index.md b/project/docs/index.md
@@ -66,7 +66,7 @@ To build the images and run the containers in the background:
 $ docker compose up --detach --build
 ```
 
-Directories such as `app/`, `tests/`, `migrations/`, and the `pyproject.toml` file are mounted to the `web` service. This allows for automatically reloading of the application when changes are made to the code.
+Directories such as `app/`, `tests/`, `migrations/`, and the `pyproject.toml` file are **bind-mounted** to their respective counterparts in the `web` service container. This setup allows for automatic reloading of the application when changes are made to the code during development.
 
 To stop the containers without removing them: