Update page descriptions and image sources

nuztalgia · Nov 27, 2022 · afbe1ec · afbe1ec
1 parent fa7ecb6
commit afbe1ec
Show file tree

Hide file tree

Showing 14 changed files with 64 additions and 2 deletions.
diff --git a/docs/api/botstrap.md b/docs/api/botstrap.md
@@ -1,3 +1,8 @@
+---
+description:
+  The primary point of integration between a Discord bot and the Botstrap library.
+---
+
 <!-- prettier-ignore -->
 ::: botstrap.Botstrap
     options:

diff --git a/docs/api/cli-colors.md b/docs/api/cli-colors.md
@@ -1,3 +1,7 @@
+---
+description: A model for the colors used by the Botstrap-provided CLI.
+---
+
 <!-- prettier-ignore -->
 ::: botstrap.CliColors
     options:

diff --git a/docs/api/cli-strings.md b/docs/api/cli-strings.md
@@ -1,3 +1,7 @@
+---
+description: A model for the strings used by the Botstrap-provided CLI.
+---
+
 <!-- prettier-ignore -->
 ::: botstrap.CliStrings
     options:

diff --git a/docs/api/color.md b/docs/api/color.md
@@ -1,3 +1,7 @@
+---
+description: A collection of functions that add color to console-printed strings.
+---
+
 <!-- prettier-ignore -->
 ::: botstrap.Color
     options:

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -1,4 +1,6 @@
 ---
+description:
+  Detailed documentation, examples, and explanations for the entire Botstrap API.
 hide:
   - footer
   - toc

diff --git a/docs/api/option.md b/docs/api/option.md
@@ -1,3 +1,7 @@
+---
+description: A model for a custom option to add to the Botstrap-provided CLI.
+---
+
 <!-- prettier-ignore -->
 ::: botstrap.Option
     options:

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,4 +1,6 @@
 ---
+description:
+  Secure your Discord bot (or spin up a new one) with just a few simple commands.
 hide:
   - footer
 ---

diff --git a/docs/images/readme.md b/docs/images/readme.md
@@ -7,7 +7,7 @@ Image Sources
 
 ## `robot-happy*`
 
-<img align="left" src="./robot-happy-white.png#gh-dark-mode-only"><img align="left" src="./robot-happy-black.png#gh-light-mode-only">
+<img alt="A white happy robot, only visible in dark mode." src="./robot-happy-white.png#gh-dark-mode-only" align="left"><img alt="A black happy robot, only visible in light mode." src="./robot-happy-black.png#gh-light-mode-only" align="left">
 
 This adorable happy robot is available from [Material Design Icons] and was originally
 created by [@coltonwiscombe]. It is distributed under the [Apache-2.0] license. Huge
@@ -20,7 +20,7 @@ thanks to the [Pictogrammers] for making these icons free and easily accessible!
 
 ## `logo-*.png`
 
-<img align="left" src="./logo-48.png">
+<img alt="The Botstrap logo; a happy robot inside a purple circle." src="./logo-48.png" align="left">
 
 The Botstrap logo was created by [@nuztalgia] based on the `robot-happy` icon. It is
 also distributed under the [Apache-2.0](/LICENSE) license. Feel free to use it for
@@ -29,3 +29,18 @@ you do! :purple_heart:
 
 [@nuztalgia]: https://github.com/nuztalgia
 [a link back to this repo]: https://github.com/nuztalgia/botstrap
+
+## `social/*.png`
+
+<a href="./social"><img alt="A tiny preview of two Botstrap social cards, both showing illegible white text on a purple background." src="https://user-images.githubusercontent.com/95021853/204147732-cdc08e3e-1c36-4bac-848a-4d347029bbb9.png" align="left"></a>
+
+All of the social cards (a.k.a. social previews) displayed when linking to a page on the
+[official Botstrap site] were generated using the [`social`] feature of [Material for
+MkDocs], which uses the [MIT] license. Forever grateful to [@squidfunk] for this amazing
+framework!
+
+[official botstrap site]: https://botstrap.readthedocs.io/
+[`social`]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
+[material for mkdocs]: https://squidfunk.github.io/mkdocs-material/
+[mit]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE
+[@squidfunk]: https://github.com/squidfunk
diff --git a/docs/internal/argstrap.md b/docs/internal/argstrap.md
@@ -1,3 +1,7 @@
+---
+description: Parses command-line args and provides a CLI framework for Discord bots.
+---
+
 ::: botstrap.internal.Argstrap
     options:
       heading_level: 1

diff --git a/docs/internal/cli-session.md b/docs/internal/cli-session.md
@@ -1,3 +1,7 @@
+---
+description: Defines UX state to ensure a consistent look/feel for a Discord bot's CLI.
+---
+
 ::: botstrap.internal.CliSession
     options:
       heading_level: 1

diff --git a/docs/internal/index.md b/docs/internal/index.md
@@ -1,4 +1,6 @@
 ---
+description:
+  Technical notes and details about classes that aren't part of Botstrap's public API.
 hide:
   - footer
   - toc

diff --git a/docs/internal/metadata.md b/docs/internal/metadata.md
@@ -1,3 +1,7 @@
+---
+description: A collection of utilities related to file, package, and program metadata.
+---
+
 ::: botstrap.internal.Metadata
     options:
       heading_level: 1

diff --git a/docs/internal/secret.md b/docs/internal/secret.md
@@ -1,3 +1,7 @@
+---
+description: Manages I/O operations for files that contain sensitive encrypted data.
+---
+
 ::: botstrap.internal.Secret
     options:
       heading_level: 1

diff --git a/docs/internal/token.md b/docs/internal/token.md
@@ -1,3 +1,7 @@
+---
+description: Represents and handles operations for an individual Discord bot token.
+---
+
 ::: botstrap.internal.Token
     options:
       heading_level: 1