Fixes after review

Author: wlkh

.github/workflows/build.yml

@@ -26,6 +26,7 @@ jobs:
     - name: Build docs
       run: |
         mkdocs build --strict
+        ./check-links.sh
 
     # Only deploy on master
     - name: Deploy docs

README.md

@@ -14,27 +14,33 @@ This is done by creating a pull request.
 Make sure you have Python3 installed.
 
 ```
-git clone https://github.com/waterlinked/waterlinked.github.io
-cd waterlinked.github.io
+git clone https://github.com/waterlinked/docs.git
+cd docs
 
 python -m venv venv
 source venv/bin/activate (Linux)
 venv\Scripts\activate.bat (Windows)
 pip install -r requirements.txt
-./install-hooks.sh
 
-mkdocs serve
+./install-hooks.sh  # (Optional) To automatically check links on git push
 ```
 
 2. Make changes using your favorite editor
 
 3. Test them
 
+```
+mkdocs serve  # Allow you to view the changes on your browser
+```
 * Fire up your browser and go to localhost:8000
 
-## Deploy changes to server
-After the changes have been tested and they work, push the changes to the master branch and Github will build the website and publish it on https://docs.waterlinked.com.
+Verify links are valid:
 
-## Automatic link-checker
-When you push to git, all links are automatically checked. Any errors will be listed in your terminal. If you want to check links before pushing, use > ./hooks/pre-push
+```
+./check-links.sh
+```
+
+## Deploy changes to server
+After the changes have been tested and they work, push the changes to a branch, and make a merge request. The documentation site will built automatically and links will be verified.
 
+Once the pull request is merged the documentation will be automatically built and published to https://docs.waterlinked.com.

checklinks.py check-internal-links.pychecklinks.py renamed to check-internal-links.py

@@ -1,6 +1,7 @@
 #!/bin/bash
 # Pre-push hook: Custom linkchecker for local links, Build MkDocs locally and run LinkChecker on external links
 
+# Exit on error
 set -e
 
 # === Paths ===
@@ -19,7 +20,7 @@ echo "Checking internal links in markdown files..."
 
 set +e
 #Using custom python script for internal link checking:
-"$VENV_BIN/python" "$PROJECT_ROOT/checklinks.py" "$DOCS_DIR"
+"$VENV_BIN/python" "$PROJECT_ROOT/check-internal-links.py" "$DOCS_DIR"
 RESULT_INTERNAL=$?
 
 set -e

hooks/pre-push check-links.shhooks/pre-push renamed to check-links.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 mkdir -p .git/hooks
-ln -sf ../../hooks/pre-push .git/hooks/pre-push
+ln -sf check-links.sh .git/hooks/pre-push
 echo "Pre-push hook installed!"

install-hooks.sh

@@ -1,3 +1,4 @@
 mkdocs==1.2.3
 mkdocs-material==7.2.0
 jinja2<3.1.0
+LinkChecker==10.3.0