feat(docs): added documentation for the updatechecker cog

This commit is contained in:
Seaswimmer 2024-01-06 18:49:19 +00:00
parent e49be8bda8
commit b9ef96665e
Signed by: cswimr
GPG key ID: D74DDDDF420E13DF
2 changed files with 24 additions and 1 deletions

22
.docs/updatechecker.md Normal file
View file

@ -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
```

View file

@ -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