improve bot docs content structure

OpenBB-finance · DidierRLopes · Nov 6, 2023 · Oct 20, 2023 · Oct 20, 2023 · Oct 21, 2023
commit 1717e626ea610dc8f8e500849489c6d35f98791e
diff --git a/website/content/bot/changelog/_category_.json b/website/content/bot/changelog/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Changelog",
-  "position": 5
+  "position": 4
 }
diff --git a/website/content/bot/faqs/generic.md → website/content/bot/faqs.md b/website/content/bot/faqs/generic.md → website/content/bot/faqs.md
@@ -1,6 +1,6 @@
 ---
-title: generic
-sidebar_position: 1
+title: FAQs
+sidebar_position: 5
 description: Here we answer frequently asked questions about the OpenBB Bot from our users and community.
 keywords:
   [

diff --git a/website/content/bot/faqs/_category_.json b/website/content/bot/faqs/_category_.json
diff --git a/website/content/bot/index.md b/website/content/bot/index.md
@@ -28,30 +28,4 @@ With OpenBB Bot, we offer free access to hundreds of commands ranging from stock
 
 OpenBB Bot was created to give individual users access to high quality financial data. We know our users love to invest and they also want to be part of a community and share ideas with their friends quickly and easily. Our Bot allows quick access to actionable market data to make you and your community better informed investors.
 
----
-
-<Card
-	type="bot"
-	title="What is OpenBB Bot?"
-	description="OpenBB Bot is a chatting bot for investment research that provides access to high quality financial data for both individual investors and online communities."
- />
-
-<Card
-	type="bot"
-	title="How can I add OpenBB Bot to my community?"
-	description="Instructions to add OpenBB Bot to your community can be found under the installation section."
-/>
-
----
-
-### Getting Started
-
-To know more about OpenBB Bot, you can start by reading the [Installation Guide](/bot/installation).
-
-### Using OpenBB Bot
-
-To learn how to use OpenBB Bot, you can start by reading the [Basics Guide](/bot/guides/discord).
-
-### Bot Reference
-
-The Reference section is a complete list of all functions available for OpenBB Bot. It can be found [here](/bot/reference/discord).
+TODO: Add image
diff --git a/website/content/bot/installation/_category_.json b/website/content/bot/installation/_category_.json
@@ -0,0 +1,4 @@
+{
+	"label": "Installation",
+	"position": 1
+}
diff --git a/website/content/bot/installation/discord.md b/website/content/bot/installation/discord.md
@@ -1,6 +1,6 @@
 ---
-title: Discord
-sidebar_position: 1
+title: Setting up Discord bot
+sidebar_position: 2
 description: How to get started with OpenBB Bot
 keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,slack]
 ---
@@ -11,8 +11,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
 
-## Discord - First Time Setup
-
 <AddBotDialogDiscord
 />
 

diff --git a/website/content/bot/installation/index.md → website/content/bot/installation/overview.md b/website/content/bot/installation/index.md → website/content/bot/installation/overview.md
@@ -1,13 +1,13 @@
 ---
-title: Installation
+title: Overview
 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, slack]
 ---
 
 import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
-<HeadTitle title="Installation - Bot | OpenBB Docs" />
+<HeadTitle title="Overview - Bot | OpenBB Docs" />
 
 import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
 import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";

diff --git a/website/content/bot/installation/telegram.md b/website/content/bot/installation/telegram.md
@@ -1,6 +1,6 @@
 ---
-title: Telegram
-sidebar_position: 1
+title: Setting up Telegram bot
+sidebar_position: 3
 description: How to get started with OpenBB Bot
 keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,]
 ---
@@ -12,8 +12,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";
 
-## Telegram Server - First Time Setup
-
 <AddBotDialogTelegram
 />
 

diff --git a/website/content/bot/usage/customizing/_category_.json b/website/content/bot/usage/customizing/_category_.json
@@ -0,0 +1,4 @@
+{
+	"label": "Customization",
+	"position": 3
+}
diff --git a/website/content/bot/usage/customizing/individual.md b/website/content/bot/usage/customizing/individual.md
@@ -10,8 +10,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 <HeadTitle title="Individual - Bot | OpenBB Docs" />
 
-## Customizing your Individual Bot Experience
-
 The individual plan offers three different capabilities - Charting, Alerts, and Watchlist. In addition to these benefits you also get unlimited commands per month after registering.
 
 <div className="flex justify-center h-full w-[800px] rounded-r-[4px]">
@@ -22,19 +20,19 @@ The individual plan offers three different capabilities - Charting, Alerts, and
   />
 </div>
 
-### Charting
+## Charting
 
 Our most popular commands center around the real-time charting capabilities we offer with OpenBB Bot. We allow you to customize many different aspects of your charts when you register with us. You can customize the chart theme and style as well as adding any on and off chart indicators you desire. These settings will apply across all platforms.
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/charting.png" alt="charting openBB" width="70%" height="70%" />
 
-### Alerts
+## Alerts
 
 Alerts are a powerful tool used by OpenBB users. Simply set the symbol and price you wish to be alerted at and we do the rest!
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/alerts.png" alt="alerts openBB" width="70%" height="70%" />
 
-### Watchlist
+## Watchlist
 
 OpenBB Watchlist is a great way to keep track of all your investments in once place. Add Crypto or Stock symbols and quickly see the prices at a glance when its convenient for you.
 You can add your tickers through the [HUB](https://my.openbb.co/app/bot/watchlist) or run ```/watchlist``` in your respective platform to configure.

diff --git a/...te/content/bot/usage/customizing/index.md → ...content/bot/usage/customizing/overview.md b/...te/content/bot/usage/customizing/index.md → ...content/bot/usage/customizing/overview.md
@@ -1,15 +1,13 @@
 ---
-title: Customization
-sidebar_position: 4
+title: Overview
+sidebar_position: 1
 description: Learn to customize your OpenBB Bot experience
 keywords: [discord, telegram, slack, how to, explanation, openbb bot, openbb, guide, bot guide, customize, individual, server]
 ---
 
 import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
-<HeadTitle title="Customization - Bot | OpenBB Docs" />
-
-## Customizing your Bot Experience
+<HeadTitle title="Overview - Bot | OpenBB Docs" />
 
 For the best user experience, you will want to customize the OpenBB Bot settings. Different types of customizations we offer are:
 

diff --git a/website/content/bot/usage/customizing/server.md b/website/content/bot/usage/customizing/server.md
@@ -9,13 +9,9 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 <HeadTitle title="Server - Bot | OpenBB Docs" />
 
-## Customizing your Server Bot Experience
-
 The Server plan for OpenBB Bot offers three different capabilities - Charting, BillBoard, and Auto Posting. Any server that registers with us on the [OpenBB HUB](https://my.openbb.co) gets access to set up one Auto Posting for free. Once you have paid plan you have full access to all these features.
 
-## Server
-
-### Auto Posting (Feeds) (Discord Only)
+## Auto Posting (Feeds) (Discord Only)
 
 Auto Posting is our most powerful feature for Discord Servers - We offer the ability to push updates into the server for Flow, Darkpool, or Heatmap/Charts. Once you set up your account you will be able to query the bot directly in your server like below :
 
@@ -47,7 +43,7 @@ For a further breakdown on what each Flow Auto Post entails - See below
 |   Whale   |    "Premium > $1.000,000" & "Days to Expiration < 45"         |
 
 
-### Auto Posting (Commands) (Discord Only)
+## Auto Posting (Commands) (Discord Only)
 
 Much like Feeds we now offer Commands to be set up as autoposts as well - These behave in the same way but can be setup to autopost bot commands.
 
@@ -65,14 +61,14 @@ Below are a few examples of autoposts set up as commands in a server :
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/flow+example.png" alt="earnings command autopost openBB" width="40%" height="40%" />
 
-### Charting
+## Charting
 
 Custom charting works the same way as Individual charting but it will apply to your full server. If you want everyone in your server to use the "Classic" theme and have RSI + 50d SMA then it will display that way for all users in your server (unless they have already registered their own individual account).
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/server-charting.png" alt="server charting openBB" width="70%" height="70%" />
 
-### BillBoard
+## Billboard
 
-BillBoard is a way to advertise to your users when they run a command on the bot. Within your server you can set your own text to display on applicable commands as they are run.
+Billboard is a way to advertise to your users when they run a command on the bot. Within your server you can set your own text to display on applicable commands as they are run.
 
 <img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/billboard.png" alt="billboard openBB" width="70%" height="70%" />
diff --git a/website/content/bot/usage/discord.md b/website/content/bot/usage/discord.md
@@ -1,6 +1,6 @@
 ---
 title: Discord
-sidebar_position: 2
+sidebar_position: 1
 description: Understand the basics for getting started and running the OpenBB Boton Discord.
 keywords: [discord, how to, explanation, openbb bot, openbb, guide, bot guide, commands, community]
 ---
@@ -9,8 +9,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 <HeadTitle title="Discord - Bot | OpenBB Docs" />
 
-## Getting Started with Discord
-
 Now that you have added the bot to your Discord you can get started with running commands.
 
 If you're new to OpenBB Discord Bot, here's a quick guide to get you started.

diff --git a/website/content/bot/usage/telegram.md b/website/content/bot/usage/telegram.md
@@ -1,6 +1,6 @@
 ---
 title: Telegram
-sidebar_position: 3
+sidebar_position: 2
 description: Understand the basics for getting started and running the OpenBB Boton Telegram.
 keywords: [telegram, how to, explanation, openbb bot, openbb, guide, bot guide, commands, community]
 ---
@@ -9,8 +9,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
 <HeadTitle title="Telegram - Bot | OpenBB Docs" />
 
-## Getting Started with Telegram
-
 Now that you have added the bot to your Telegram server you can get started with running commands.
 
 To use it, you need to type slash commands in the chat. A slash command starts with a / followed by a keyword and an optional argument. For example, ```/cd AAPL``` will show you the daily chart for Apple stock.