From 4c98d00641457cd649bea0216b1aec430657168e Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Thu, 1 Feb 2024 17:19:23 -0500 Subject: [PATCH] fix(docs): few documentation fixes --- .docs/aurora/index.md | 4 ++-- .docs/backup.md | 4 ++-- .docs/bible.md | 2 +- .docs/nerdify.md | 4 ++-- mkdocs.yml | 2 ++ 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.docs/aurora/index.md b/.docs/aurora/index.md index 48905f1..839bccb 100644 --- a/.docs/aurora/index.md +++ b/.docs/aurora/index.md @@ -10,7 +10,7 @@ Aurora is a fully-featured moderation system. It is heavily inspired by Galactic ## Installation ```bash -[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs -[p]cog install seacogs aurora +[p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs +[p]cog install sea-cogs aurora [p]cog load aurora ``` diff --git a/.docs/backup.md b/.docs/backup.md index 550f7da..913fdbf 100644 --- a/.docs/backup.md +++ b/.docs/backup.md @@ -5,8 +5,8 @@ Backup allows you to export a JSON list of all of your installed repositories an ## Installation ```bash -[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs -[p]cog install seacogs backup +[p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs +[p]cog install sea-cogs backup [p]cog load backup ``` diff --git a/.docs/bible.md b/.docs/bible.md index 142fc98..00a4825 100644 --- a/.docs/bible.md +++ b/.docs/bible.md @@ -13,7 +13,7 @@ This cog does require an api key to work. ## Setup -This cog requires an [API.Bible]() API key to function. You can sign up for an account [here](https://scripture.api.bible/signup). This will also generate your first API key for you. +This cog requires an [API.Bible](https://scripture.api.bible/) API key to function. You can sign up for an account [here](https://scripture.api.bible/signup). This will also generate your first API key for you. Then, you can use `[p]set api` to set the API key. Make sure your formatting matches the screenshot below. ![image](img/bible/set-api.png) diff --git a/.docs/nerdify.md b/.docs/nerdify.md index f801d29..d39ffe3 100644 --- a/.docs/nerdify.md +++ b/.docs/nerdify.md @@ -5,8 +5,8 @@ Nerdify allows you to nerdify other people's text. ## Installation ```bash -[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs -[p]cog install seacogs nerdify +[p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs +[p]cog install sea-cogs nerdify [p]cog load nerdify ``` diff --git a/mkdocs.yml b/mkdocs.yml index 2b9fadd..dd01dbf 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 + - Bible: bible.md - Backup: backup.md - Nerdify: nerdify.md @@ -102,4 +103,5 @@ theme: watch: - ./aurora - ./backup + - ./bible - ./nerdify