cswimr/SeaCogs
cswimr/SeaCogs
1
1
Fork 1
Code Issues 10 Pull requests 4 Projects 1 Packages 1 Wiki Activity Actions

fix(docs): few documentation fixes
All checks were successful
Actions / Lint Code (Pylint) (push) Successful in 16s
Details
Actions / Build Documentation (MkDocs) (push) Successful in 12s
Details

Browse source
This commit is contained in:
Seaswimmer 2024-02-01 17:19:23 -05:00
parent 39fafede67
commit 4c98d00641
Signed by: cswimr
GPG key ID: B8953EC01E5C4063
5 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.docs/aurora/index.md
View file

@ -10,7 +10,7 @@ Aurora is a fully-featured moderation system. It is heavily inspired by Galactic
## Installation ## Installation
```bash ```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs [p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs aurora [p]cog install sea-cogs aurora
[p]cog load aurora [p]cog load aurora
``` ```

4
.docs/backup.md
View file

@ -5,8 +5,8 @@ Backup allows you to export a JSON list of all of your installed repositories an
## Installation ## Installation
```bash ```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs [p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs backup [p]cog install sea-cogs backup
[p]cog load backup [p]cog load backup
``` ```

2
.docs/bible.md
View file

@ -13,7 +13,7 @@ This cog does require an api key to work.
## Setup ## 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. 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) ![image](img/bible/set-api.png)

4
.docs/nerdify.md
View file

@ -5,8 +5,8 @@ Nerdify allows you to nerdify other people's text.
## Installation ## Installation
```bash ```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs [p]repo add sea-cogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs nerdify [p]cog install sea-cogs nerdify
[p]cog load nerdify [p]cog load nerdify
``` ```

2
mkdocs.yml
View file

@ -16,6 +16,7 @@ nav:
- Moderation Commands: aurora/moderation-commands.md - Moderation Commands: aurora/moderation-commands.md
- Case Commands: aurora/case-commands.md - Case Commands: aurora/case-commands.md
- Configuration: aurora/configuration.md - Configuration: aurora/configuration.md
- Bible: bible.md
- Backup: backup.md - Backup: backup.md
- Nerdify: nerdify.md - Nerdify: nerdify.md
@ -102,4 +103,5 @@ theme:
watch: watch:
- ./aurora - ./aurora
- ./backup - ./backup
- ./bible
- ./nerdify - ./nerdify