docs: update docs

SurPathHub · Nov 8, 2021 · ba83c19 · ba83c19
1 parent 3f2d0f6
commit ba83c19
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 46 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 # Table of contents
 
-* [Introduction](../README.md)
-* [Setup](./setup.md)
-* [Commands](./commands.md)
-* [Events](./events.md)
-* [Vendors](./vendors.md)
+- [Introduction](../README.md)
+- [Setup](./setup.md)
+- [Commands](./commands.md)
+- [Events](./events.md)
+- [Vendors](./vendors.md)
diff --git a/docs/commands.md b/docs/commands.md
@@ -12,4 +12,4 @@ Here's the list of commands available in Dayong.
 | Name                | Description                      | Usage                            | Cooldown  |
 | ------------------- | -------------------------------- | :------------------------------: | :-------: |
 | **anon**            | Sends an anonymized message.     | `/anon message: <message>`       |    null   |
-| **content**         | Schedules a recurring task that retrieves content from a microservice, API, or email subscription. For `source`, see [vendors](./vendors.md#content-providers). | `/content source: <content provider> interval: <seconds> action: <start \| stop>` |    null   |
+| **content**         | Schedules a recurring task that retrieves content from a service or email subscription. For `source`, see [vendors](./vendors.md#content-providers). | `/content source: <content provider alias> action: <start \| stop>` |    null   |
diff --git a/docs/events.md b/docs/events.md
@@ -2,6 +2,6 @@ Here's the list of events available in Dayong.
 
 ## Events
 
-| Name                | Description                      |
-| ------------------- | -------------------------------- |
-| greet_new_member    | Welcomes new guild members.      |
+| Name             | Description                 |
+| ---------------- | --------------------------- |
+| greet_new_member | Welcomes new guild members. |
diff --git a/docs/setup.md b/docs/setup.md
@@ -5,40 +5,43 @@ Follow the instructions here: https://discordpy.readthedocs.io/en/stable/discord
 ## Bot Setup
 
 | ❗❗ Before you start, fork your own copy of SurPathHub/Dayong. |
-|-----------------------------------------|
+| --------------------------------------------------------------- |
 
 | ❗❗ You can also perform the steps below directly on your copy of Dayong on GitHub |
-|-----------------------------------------|
+| ----------------------------------------------------------------------------------- |
 
-| ❗❗ Your copy of the GitHub repository can be used to deploy changes automatically.|
-|-----------------------------------------|
+| ❗❗ Your copy of the GitHub repository can be used to deploy changes automatically. |
+| ------------------------------------------------------------------------------------ |
 
 1. Clone your fork to your local machine.
 
-    HTTP
-    ```
-    git clone https://github.com/<your username>/Dayong.git
-    ```
+   HTTP
 
-    SSH
-    ```
-    git clone git@github.com:<your username>/Dayong.git
-    ```
+   ```
+   git clone https://github.com/<your username>/Dayong.git
+   ```
 
-    GitHub CLI
-    ```
-    gh repo clone <your username>/Dayong.git
-    ```
+   SSH
+
+   ```
+   git clone git@github.com:<your username>/Dayong.git
+   ```
+
+   GitHub CLI
+
+   ```
+   gh repo clone <your username>/Dayong.git
+   ```
 
 2. Go to the project root directory.
 
-    ```
-    cd Dayong
-    ```
+   ```
+   cd Dayong
+   ```
 
 3. Edit the `config.json` file and its values as necessary.
 
-    The `config.json` file stores public options, settings, properties, configuration, and preferences.
+   The `config.json` file stores public options, settings, properties, configuration, and preferences.
 
 4. After setting up Dayong, `commit` and `push` your changes.
 
@@ -50,21 +53,23 @@ Follow the instructions here: https://discordpy.readthedocs.io/en/stable/discord
 
 2. Go to the project root directory.
 
-    ```
-    cd Dayong
-    ```
+   ```
+   cd Dayong
+   ```
 
 3. Create a copy of `.env.example`. Don't forget to omit the `.example` at the end.
 
-    On Linux and Unix
-    ```
-    cp .env.example .env
-    ```
+   On Linux and Unix
+
+   ```
+   cp .env.example .env
+   ```
+
+   On Windows
 
-    On Windows
-    ```
-    copy .env.example .env
-    ```
+   ```
+   copy .env.example .env
+   ```
 
 4. Edit the `.env` file and add your credentials to the corresponding variables.
 
@@ -76,12 +81,12 @@ Follow the instructions here: https://discordpy.readthedocs.io/en/stable/discord
 
 8. Edit the `config.json` file and its values as necessary.
 
-    The `config.json` file stores public options, settings, properties, configuration, and preferences.
+   The `config.json` file stores public options, settings, properties, configuration, and preferences.
 
 9. Quickly test if the configuration works by running:
 
-    ```
-    python dayong
-    ```
+   ```
+   python dayong
+   ```
 
 10. After setting up Dayong, `git commit` and `git push` your changes.
diff --git a/docs/vendors.md b/docs/vendors.md
@@ -3,7 +3,13 @@ Here is the list of 3rd party service providers.
 ## Content Providers
 
 #### Email Subscription
-- [medium.com](https://medium.com/)
+
+|               Name                | alias  |
+| :-------------------------------: | :----: |
+| [medium.com](https://medium.com/) | medium |
 
 #### Web API
-- [dev.to](http://dev.to/)
+
+|           Name           | alias |
+| :----------------------: | :---: |
+| [dev.to](http://dev.to/) |  dev  |