Skip to content

Commit

Permalink
Improve overall docusaurus (#4675)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
2 people authored and jmaslek committed Apr 12, 2023
1 parent 24a3202 commit f692e45
Show file tree
Hide file tree
Showing 154 changed files with 4,137 additions and 4,140 deletions.
25 changes: 20 additions & 5 deletions website/content/bot/Installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_0.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_1.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_2.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_3.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_4.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_5.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_6.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_7.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version1_0_8.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions website/content/bot/changelog/version2_0_0.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 0 additions & 4 deletions website/content/bot/guides/_category_.json

This file was deleted.

15 changes: 0 additions & 15 deletions website/content/bot/guides/customizing/index.md

This file was deleted.

33 changes: 0 additions & 33 deletions website/content/bot/guides/customizing/individual.md

This file was deleted.

42 changes: 0 additions & 42 deletions website/content/bot/guides/customizing/server.md

This file was deleted.

24 changes: 0 additions & 24 deletions website/content/bot/guides/discord.md

This file was deleted.

30 changes: 0 additions & 30 deletions website/content/bot/guides/telegram.md

This file was deleted.

7 changes: 6 additions & 1 deletion website/content/bot/installation/discord.md
Original file line number Diff line number Diff line change
Expand Up @@ -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%" />

Expand Down
8 changes: 6 additions & 2 deletions website/content/bot/installation/telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -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%" />

Expand Down
2 changes: 1 addition & 1 deletion website/content/bot/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Reference",
"label": "Commands",
"position": 3
}
2 changes: 1 addition & 1 deletion website/content/bot/reference/discord/flow/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/content/bot/reference/discord/flow/opening.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit f692e45

Please sign in to comment.