Add docs tests (#294)

Author: Archmonger

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+## Description
+
+<!-- A summary of the changes. -->
+
+## Checklist
+
+Please update this checklist as you complete each item:
+
+-   [ ] Tests have been developed for bug fixes or new functionality.
+-   [ ] The changelog has been updated, if necessary.
+-   [ ] Documentation has been updated, if necessary.
+-   [ ] GitHub Issues closed by this PR have been linked.
+
+<sub>By submitting this pull request I agree that all contributions comply with this project's open source license(s).</sub>

.github/workflows/test-codeql-analysis.yml

@@ -0,0 +1,30 @@
+name: Documentation Tests
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+    schedule:
+        - cron: "0 0 * * 0"
+
+jobs:
+    docs:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v5
+              with:
+                  python-version: 3.x
+            - name: Check docs build
+              run: |
+                  pip install -r requirements/docs.txt
+                  linkcheckMarkdown docs/ -v -r
+                  linkcheckMarkdown README.md -v -r
+                  linkcheckMarkdown CHANGELOG.md -v -r
+                  cd docs
+                  mkdocs build --strict

.github/workflows/test-docs.yml

@@ -1,6 +1,6 @@
 # Conreq Beta
 
-[![Docker Pulls](https://img.shields.io/docker/pulls/roxedus/conreq?style=flat-square)](https://hub.docker.com/r/roxedus/conreq) [![Docker Stars](https://img.shields.io/docker/stars/roxedus/conreq?style=flat-square)](https://hub.docker.com/r/roxedus/conreq) [![Docker Hub](https://img.shields.io/badge/Open%20On-DockerHub-blue?style=flat-square)](https://hub.docker.com/r/roxedus/conreq) [![Discord](https://img.shields.io/discord/440067432552595457?style=flat-square&label=Discord&logo=discord)](https://discord.gg/gQhGZzEjmX "Chat with the community and get realtime support!")
+[![Docker Hub](https://img.shields.io/badge/Docker-DockerHub-blue?style=flat-square)](https://hub.docker.com/r/archmonger/conreq) [![GitHub Container Registry](https://img.shields.io/badge/Docker-GitHub-blue?style=flat-square)](https://github.com/Archmonger/Conreq/pkgs/container/conreq) [![Discord](https://img.shields.io/discord/440067432552595457?style=flat-square&label=Discord&logo=discord)](https://discord.gg/gQhGZzEjmX "Chat with the community and get realtime support!")
 
 ## Notice - July 11th, 2022
 
@@ -20,7 +20,7 @@ Looking for more info? Are you a developer and want to contribute? Check out our
 
 ## Installation (Production Environment)
 
-Install through **[Unraid Community Applications](https://squidly271.github.io/forumpost0.html)**, or **[Hotio](https://hotio.dev/containers/conreq/)**/**[SelfHosters](https://registry.hub.docker.com/r/roxedus/conreq) Docker**.
+Install through [Unraid Community Applications](https://squidly271.github.io/forumpost0.html), or [Docker](https://archmonger.github.io/Conreq/latest/install/docker/).
 
 Here's a list of all available environment variables:
 

CHANGELOG.md

@@ -11,7 +11,7 @@
     default-character-set = utf8
     ```
 
-    _Take a look at [MySQL's docs](https://dev.mysql.com/doc/refman/8.0/en/option-files.html) for all available parameters._
+    _Take a look at MySQL's "Options Files" docs for all available parameters._
 
 3.  Set your `DB_ENGINE ` variable to `MYSQL` and your `MYSQL_CONFIG_FILE` variable to the path to your `mysql.cnf` file.
 

README.md

@@ -1,12 +1,12 @@
-We use [`hypercorn`](https://github.com/pgjones/hypercorn/) as Conreq's production-grade webserver. This webserver can be directly exposed to the internet. For more information beyond what is in this guide, check out the [`hypercorn` documentation](https://pgjones.gitlab.io/hypercorn/).
+We use [`hypercorn`](https://github.com/pgjones/hypercorn/) as Conreq's production-grade webserver. This webserver can be directly exposed to the internet. For more information beyond what is in this guide, check out the [`hypercorn` documentation](https://hypercorn.readthedocs.io/en/latest/).
 
 ---
 
 The Conreq webserver can be modified through a `hypercorn.toml` file.
 
 1.  Create a `hypercorn.toml` file within your Conreq data directory (such as `./conreq/data/hypercorn.toml`)
 
-2.  Populate this `toml` file with any property in the [`hypercorn`'s documentation](https://pgjones.gitlab.io/hypercorn/how_to_guides/configuring.html#configuration-options). For example...
+2.  Populate this `toml` file with any property in the [`hypercorn`'s documentation](https://hypercorn.readthedocs.io/en/latest/how_to_guides/configuring.html#configuration-options). For example...
 
     ```toml
     bind = "0.0.0.0:5357"

docs/src/configure/mysql.md

@@ -10,4 +10,4 @@ Want to join the community or have a question? Chat with us on [Discord](https:/
 
 ## Communities
 
-[:fontawesome-brands-discord: Discord](https://discord.gg/gQhGZzEjmX){ .md-button .md-button--primary } [:fontawesome-brands-reddit: Reddit](https://www.reddit.com/r/conreq/){ .md-button .md-button--primary } [:fontawesome-brands-github: GitHub Discussions](https://github.com/Archmonger/Conreq/discussions){ .md-button .md-button--primary }
+[:fontawesome-brands-discord: Discord](https://discord.gg/gQhGZzEjmX){ .md-button .md-button--primary } [:fontawesome-brands-github: GitHub Discussions](https://github.com/Archmonger/Conreq/discussions){ .md-button .md-button--primary }