From b9ef96665eb50c0284da5689b265e3337a907daf Mon Sep 17 00:00:00 2001
From: SeaswimmerTheFsh <seaswimmerthefsh@gmail.com>
Date: Sat, 6 Jan 2024 18:49:19 +0000
Subject: [PATCH] feat(docs): added documentation for the updatechecker cog

---
 .docs/updatechecker.md | 22 ++++++++++++++++++++++
 mkdocs.yml             |  3 ++-
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 .docs/updatechecker.md

diff --git a/.docs/updatechecker.md b/.docs/updatechecker.md
new file mode 100644
index 0000000..2926302
--- /dev/null
+++ b/.docs/updatechecker.md
@@ -0,0 +1,22 @@
+# UpdateChecker
+
+/// admonition | This project is not ready for production use
+    type: danger
+The UpdateChecker cog is currently in an unfinished state, until it is completed please use [NeuroAssassin's UpdateChecker cog](https://github.com/NeuroAssassin/Toxic-Cogs) instead.
+///
+
+UpdateChecker will tell when there is an update available for a repository you have added for your bot, and, depending on settings, will auto update or will just notify you.
+
+This is a fork of [NeuroAssassin's UpdateChecker cog](https://github.com/NeuroAssassin/Toxic-Cogs).  
+Additional features include support for Gitea/Forgejo RSS feeds, instead of just GitHub. (1)
+{ .annotate }
+
+1. ⚠️ Not yet implemented.
+
+## Installation
+
+```bash
+[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
+[p]cog install seacogs updatechecker
+[p]cog load updatechecker
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 470aa1b..b61c86c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: SeaCogs Documentation
-site_url: https://seacogs.readthedocs.io
+site_url: http://seacogs.pages.coastalcommits.com
 repo_name: CoastalCommits
 repo_url: https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
 edit_uri: src/branch/main/.docs
@@ -17,6 +17,7 @@ nav:
     - Case Commands: aurora/case-commands.md
     - Configuration: aurora/configuration.md
   - Nerdify: nerdify.md
+  - UpdateChecker: updatechecker.md
 
 plugins:
   - git-authors