docs(hotreload): add docs
Some checks failed
Actions / Build Documentation (MkDocs) (push) Successful in 43s
Actions / Lint Code (Ruff & Pylint) (push) Has been cancelled

This commit is contained in:
cswimr 2025-01-26 15:28:21 +00:00
parent b22d81f514
commit 1993da084d
Signed by: cswimr
GPG key ID: 0EC431A8DA8F8087
2 changed files with 38 additions and 8 deletions

22
.docs/hotreload.md Normal file
View file

@ -0,0 +1,22 @@
# HotReload
HotReload automatically reloads cogs in local cog paths on file change.
This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog.
## Installation
```bash
[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
[p]cog install seacogs hotreload
[p]cog load hotreload
```
## Commands
### hotreload notifychannel
Set the channel where hotreload will send notifications when a cog is reloaded.
### hotreload list
Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths.

View file

@ -1,15 +1,23 @@
{
"author" : ["cswimr"],
"install_msg" : "Thank you for installing HotReload! This cog does not provide any commands, please see the [documentation](https://seacogs.coastalcommits.com/hotreload) for more information.",
"name" : "HotReload",
"short" : "Automatically reload cogs in local cog paths on file change.",
"description" : "Automatically reload cogs in local cog paths on file change.",
"end_user_data_statement" : "This cog does not store end user data.",
"author": [
"cswimr"
],
"install_msg": "Thank you for installing HotReload! Please see the [documentation](https://seacogs.coastalcommits.com/hotreload) to get started.",
"name": "HotReload",
"short": "Automatically reload cogs in local cog paths on file change.",
"description": "Automatically reload cogs in local cog paths on file change.",
"end_user_data_statement": "This cog does not store end user data.",
"hidden": false,
"disabled": false,
"min_bot_version": "3.5.0",
"min_python_version": [3, 10, 0],
"requirements": ["watchdog"],
"min_python_version": [
3,
10,
0
],
"requirements": [
"watchdog"
],
"tags": [
"utility",
"development"