Improve overall docusaurus (#4675)

* Improve overall docusaurus * update pypi on installation * fix merge conflicts * fix spelling * change CRLF to LF * improve docs installation for bot * more changes * few more * fix --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
OpenBB-finance · Apr 7, 2023 · 2754be2 · 2754be2
1 parent 5b4ad7c
commit 2754be2
Show file tree

Hide file tree

Showing 158 changed files with 4,208 additions and 4,021 deletions.
diff --git a/website/content/bot/Installation/index.md b/website/content/bot/Installation/index.md
@@ -5,11 +5,26 @@ description: How to get started with OpenBB Bot
 keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,]
 ---
 
-import AddBotDialog from "@site/src/components/General/AddBot";
+Currently we support [Discord](Installation/discord) and [Telegram](Installation/telegram) for the OpenBB Bot. More integrations are under way.
 
-## Adding Bot to your Server
+In order to use OpenBB Bot in one of these chatting applications you need to either:
+<div>
+  <ul>
+    <li>
+      Belong to a server that has already added our bot (<strong>INDIVIDUAL</strong>)
+    </li>
+    <li>
+      Own a server and you can easily add our bot (<strong>SERVER</strong>)
+    </li>
+  </ul>
+</div>
 
-To add the bot to your server click on one of the links for your respective platform and then follow the instructions below.
+By using the [Linked Platforms page](https://my.openbb.co/app/bot/linked-platforms) you are also able to link your Discord/Telegram account to the OpenBB Bot and open up even more features.
 
-<AddBotDialog
-/>
+<h2 className="tracking-widest uppercase text-lg lg:text-xl">
+  What are you waiting for?
+</h2>
+
+Over 1.5 Million commands have been run on the OpenBB Bot. Join the community and start using OpenBB Bot today!
+
+Check our user metrics in our [Open page](https://openbb.co/open).
diff --git a/website/content/bot/changelog/version1_0_0.mdx b/website/content/bot/changelog/version1_0_0.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.0
+title: v1.0.0
 version: "1.0.0"
 date: 2022-08-03
-description: Version 1.0.0
+description: v1.0.0
 sidebar_position: 9
 ---
 

diff --git a/website/content/bot/changelog/version1_0_1.mdx b/website/content/bot/changelog/version1_0_1.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.1
+title: v1.0.1
 version: "1.0.1"
 date: 2022-08-04
-description: Version 1.0.1
+description: v1.0.1
 sidebar_position: 8
 ---
 

diff --git a/website/content/bot/changelog/version1_0_2.mdx b/website/content/bot/changelog/version1_0_2.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.2
+title: v1.0.2
 version: "1.0.2"
 date: 2022-08-05
-description: Version 1.0.2
+description: v1.0.2
 sidebar_position: 7
 ---
 

diff --git a/website/content/bot/changelog/version1_0_3.mdx b/website/content/bot/changelog/version1_0_3.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.3
+title: v1.0.3
 version: "1.0.3"
 date: 2022-08-12
-description: Version 1.0.3
+description: v1.0.3
 sidebar_position: 6
 ---
 

diff --git a/website/content/bot/changelog/version1_0_4.mdx b/website/content/bot/changelog/version1_0_4.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.4
+title: v1.0.4
 version: "1.0.4"
 date: 2022-08-16
-description: Version 1.0.4
+description: v1.0.4
 sidebar_position: 5
 ---
 

diff --git a/website/content/bot/changelog/version1_0_5.mdx b/website/content/bot/changelog/version1_0_5.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.5
+title: v1.0.5
 version: "1.0.5"
 date: 2022-08-30
-description: Version 1.0.5
+description: v1.0.5
 sidebar_position: 4
 ---
 

diff --git a/website/content/bot/changelog/version1_0_6.mdx b/website/content/bot/changelog/version1_0_6.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.6
+title: v1.0.6
 version: "1.0.6"
 date: 2022-09-12
-description: Version 1.0.6
+description: v1.0.6
 sidebar_position: 3
 ---
 

diff --git a/website/content/bot/changelog/version1_0_7.mdx b/website/content/bot/changelog/version1_0_7.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.7
+title: v1.0.7
 version: "1.0.7"
 date: 2022-09-12
-description: Version 1.0.7
+description: v1.0.7
 sidebar_position: 2
 ---
 

diff --git a/website/content/bot/changelog/version1_0_8.mdx b/website/content/bot/changelog/version1_0_8.mdx
@@ -1,8 +1,8 @@
 ---
-title: Version 1.0.8
+title: v1.0.8
 version: "1.0.8"
 date: 2022-10-13
-description: Version 1.0.8
+description: v1.0.8
 sidebar_position: 1
 ---
 

diff --git a/website/content/bot/changelog/version2_0_0.mdx b/website/content/bot/changelog/version2_0_0.mdx
@@ -1,8 +1,8 @@
 ---
-title: Current - Version 2.0.0
+title: Current - v2.0.0
 version: "2.0.0"
 date: 2022-10-26
-description: Version 2.0.0
+description: v2.0.0
 sidebar_position: 0
 ---
 

diff --git a/website/content/bot/guides/_category_.json b/website/content/bot/guides/_category_.json
diff --git a/website/content/bot/guides/customizing/index.md b/website/content/bot/guides/customizing/index.md
diff --git a/website/content/bot/installation/discord.md b/website/content/bot/installation/discord.md
@@ -5,9 +5,14 @@ description: How to get started with OpenBB Bot
 keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,]
 ---
 
+import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
+
 ## Discord - First Time Setup
 
-A pop-up window will open, asking you to log in to your Discord account and allow the bot access.
+<AddBotDialogDiscord
+/>
+
+After clicking on the "Add bot to Discord" button, A pop-up window will open, asking you to log in to your Discord account and allow the bot access.
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/discord_step_1.png" alt="discord bot setup step 1" width="40%" height="40%" />
 

diff --git a/website/content/bot/installation/telegram.md b/website/content/bot/installation/telegram.md
@@ -4,10 +4,14 @@ sidebar_position: 1
 description: How to get started with OpenBB Bot
 keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,]
 ---
+import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";
 
-## Telegram - First Time Setup
+## Telegram Server - First Time Setup
 
-After clicking on the Add to Telegram button it should open a chat with our OpenBB Bot.
+<AddBotDialogTelegram
+/>
+
+After clicking on the "Add bot to Telegram" button it should open a chat with our OpenBB Bot.
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/telegram_step_1.png" alt="telegram bot setup step 1" width="40%" height="40%" />
 

diff --git a/website/content/bot/reference/_category_.json b/website/content/bot/reference/_category_.json
@@ -1,4 +1,4 @@
 {
-    "label": "Reference",
+    "label": "Commands",
     "position": 3
   }
diff --git a/website/content/bot/reference/discord/flow/index.mdx b/website/content/bot/reference/discord/flow/index.mdx
@@ -16,7 +16,7 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard";
 />
 <ReferenceCard
     title="opening"
-    description="This command allows the user to retrieve the Top 20 flows by premium for a stock with the "Opening" condition -..."
+    description="This command allows the user to retrieve the Top 20 flows by premium for a stock with the Opening condition -..."
     url="/bot/reference/discord/flow/opening"
 />
 <ReferenceCard

diff --git a/website/content/bot/reference/discord/flow/opening.md b/website/content/bot/reference/discord/flow/opening.md
@@ -6,7 +6,7 @@ description: OpenBB Discord Command
 
 # opening
 
-This command allows the user to retrieve the Top 20 flows by premium for a stock with the "Opening" condition - Volume exceeding Open Interest on the trade.
+This command allows the user to retrieve the Top 20 flows by premium for a stock with the Opening condition - Volume exceeding Open Interest on the trade.
 
 ### Usage
 

diff --git a/website/content/bot/reference/telegram/charts/c.md b/website/content/bot/reference/telegram/charts/c.md
@@ -1,42 +1,42 @@
----
-########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
-title: c
-description: OpenBB Telegram Command
----
-
-# c
-
-This command will retrieve a candlestick chart for the crypto coin provided. The interval provided must be a valid time interval (default 15 minutes). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information.
-
-### Usage
-
-```python wordwrap
-/c symbol [currency] [exchange] [interval] [srlines] [fibs]
-```
-
----
-
-## Parameters
-
-| Name | Description | Optional | Choices |
-| ---- | ----------- | -------- | ------- |
-| symbol | Crypto Symbol | False | None |
-| currency | Crypto Currency. Default: USDT | True | None |
-| exchange | Crypto Exchange. Default: binanceus | True | None |
-| interval | 1m: 1 Minute 3m: 3 Minutes 5m: 5 Minutes 15m: 15 Minutes 30m: 30 Minutes 1hr: 1 Hour 1d: 1 Day 1wk: 1 Week 1mo: 1 Month | True | 1m, 3m, 5m, 15m, 30m, 1hr, 1d, 1wk, 1mo |
-| srlines | Show Support/Resistance Lines. Default: False | True | None |
-| fibs | Show Fibonacci Retracement Levels. Default: False | True | None |
-
-
----
-
-## Examples
-
-```
-/c doge
-```
-
-```
-/c doge interval:3m
-```
----
+---
+########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
+title: c
+description: OpenBB Telegram Command
+---
+
+# c
+
+This command will retrieve a candlestick chart for the crypto coin provided. The interval provided must be a valid time interval (default 15 minutes). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information.
+
+### Usage
+
+```python wordwrap
+/c symbol [currency] [exchange] [interval] [srlines] [fibs]
+```
+
+---
+
+## Parameters
+
+| Name | Description | Optional | Choices |
+| ---- | ----------- | -------- | ------- |
+| symbol | Crypto Symbol | False | None |
+| currency | Crypto Currency. Default: USDT | True | None |
+| exchange | Crypto Exchange. Default: binanceus | True | None |
+| interval | 1m: 1 Minute 3m: 3 Minutes 5m: 5 Minutes 15m: 15 Minutes 30m: 30 Minutes 1hr: 1 Hour 1d: 1 Day 1wk: 1 Week 1mo: 1 Month | True | 1m, 3m, 5m, 15m, 30m, 1hr, 1d, 1wk, 1mo |
+| srlines | Show Support/Resistance Lines. Default: False | True | None |
+| fibs | Show Fibonacci Retracement Levels. Default: False | True | None |
+
+
+---
+
+## Examples
+
+```
+/c doge
+```
+
+```
+/c doge interval:3m
+```
+---
diff --git a/website/content/bot/reference/telegram/charts/c15m.md b/website/content/bot/reference/telegram/charts/c15m.md
@@ -1,34 +1,34 @@
----
-########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
-title: c15m
-description: OpenBB Telegram Command
----
-
-# c15m
-
-This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements.
-
-### Usage
-
-```python wordwrap
-/c15m ticker
-```
-
----
-
-## Parameters
-
-| Name | Description | Optional | Choices |
-| ---- | ----------- | -------- | ------- |
-| ticker | Stock Ticker | False | None |
-
-
----
-
-## Examples
-
-```
-/c15m AMD
-```
-
----
+---
+########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
+title: c15m
+description: OpenBB Telegram Command
+---
+
+# c15m
+
+This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements.
+
+### Usage
+
+```python wordwrap
+/c15m ticker
+```
+
+---
+
+## Parameters
+
+| Name | Description | Optional | Choices |
+| ---- | ----------- | -------- | ------- |
+| ticker | Stock Ticker | False | None |
+
+
+---
+
+## Examples
+
+```
+/c15m AMD
+```
+
+---