From 6fbfa96cf28eb213a4e7a00f47477ede04bb565a Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Wed, 31 Jan 2024 12:31:37 -0500 Subject: [PATCH] feat(docs): added Backup documentation --- .docs/backup.md | 25 +++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 .docs/backup.md diff --git a/.docs/backup.md b/.docs/backup.md new file mode 100644 index 0000000..dfc499b --- /dev/null +++ b/.docs/backup.md @@ -0,0 +1,25 @@ +# Backup + +Backup allows you to export a JSON list of all of your installed repositories and cogs, then reimport them and automatically reinstall/reload the cogs. + +## Installation + +```bash +[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs +[p]cog install seacogs backup +[p]cog load backup +``` + +## Commands + +#### backup export + +- Usage: `[p]backup export` + +Exports a JSON list of all of your added repositories, and their installed cogs. + +#### backup import + +- Usage: `[p]backup import [json]` + +Imports, reinstalls, and reloads cogs from a valid export. Requires either the json export to be provided in the command's message content or to be attached to the command's message. Ignores itself and PyLav cogs. diff --git a/mkdocs.yml b/mkdocs.yml index 1f91b56..2b9fadd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,6 +16,7 @@ nav: - Moderation Commands: aurora/moderation-commands.md - Case Commands: aurora/case-commands.md - Configuration: aurora/configuration.md + - Backup: backup.md - Nerdify: nerdify.md plugins: @@ -100,4 +101,5 @@ theme: watch: - ./aurora + - ./backup - ./nerdify