docs: catch invalid target references

The scheduled linkcheck job fails without notification. To
catch the failure, a github workflow has been added which
comments on issue 4106 so that the maintainers get notified.

Signed-off-by: Taimoor Zaeem <[email protected]>

Author: taimoorzaeem

.github/workflows/linkcheck.yaml

@@ -1,6 +1,9 @@
 name: Linkcheck
 
 on:
+  pull_request: # Temporarily test using PR, remove this before merge
+    branches:
+      - main
   schedule:
     - cron: '1 2 * * 3'
 
@@ -15,3 +18,15 @@ jobs:
         authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
         tools: docs.linkcheck.bin
     - run: postgrest-docs-linkcheck
+
+  on-linkcheck-fail:
+    runs-on: ubuntu-latest
+    needs: linkcheck
+    if: failure()
+    steps:
+    - name: Notify on linkcheck failure by commenting
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        issue-number: 4106
+        body: |
+          ❌ **Linkcheck Job Failed!**

docs/index.rst

@@ -214,6 +214,7 @@ Here are some companies that use PostgREST in production.
   - See how Nimbus uses PostgREST in `Paul Copplestone's blog post <https://paul.copplest.one/blog/nimbus-tech-2019-04.html>`_.
 * `OpenBooking <https://openbooking.ch>`_
 * `Supabase <https://supabase.com>`_
+* `Fake link <https://fake.postgrest.com>`_ .. TODD remove this before merge
 
 Testimonials
 ------------