Skip to content

Commit

Permalink
Documentation push (#4501)
Browse files Browse the repository at this point in the history
* hi didier

* Add files

* Add the changelogs from GH

* Api keys + cleaning up spelling + found some old refs

* spelling

* Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0

* updates to faq sections

* spelling

* fixing FA so it runs

* adding guides - need pics

* telegram/discord docs markdown format conversion

* fix: added new reference styles

* adding examples to discord - remove play button

* updating bot docs

* image showing on docs

Co-authored-by: jose-donato <[email protected]>

* feat: added imageurl for examples

* updates Stocks SDK intro

* bot pics update

* updating rest of bot docs

* adding code for generating index and bot updates

* linting

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* add some updates to guide for auto select commands

* Add pytest-recorder to requirements.txt

---------

Co-authored-by: Theodore Aptekarev <[email protected]>
Co-authored-by: andrewkenreich <[email protected]>
Co-authored-by: Danglewood <[email protected]>
Co-authored-by: teh_coderer <[email protected]>
Co-authored-by: jose-donato <[email protected]>
Co-authored-by: jose-donato <[email protected]>
  • Loading branch information
7 people committed Apr 12, 2023
1 parent 55f5b8a commit c363019
Show file tree
Hide file tree
Showing 89 changed files with 529 additions and 8,752 deletions.
23 changes: 0 additions & 23 deletions website/content/bot/faqs/individual.md

This file was deleted.

23 changes: 0 additions & 23 deletions website/content/bot/faqs/server.md

This file was deleted.

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

This file was deleted.

4 changes: 4 additions & 0 deletions website/content/bot/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Guides",
"position": 3
}
15 changes: 15 additions & 0 deletions website/content/bot/guides/customizing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Customizing
sidebar_position: 3
description: TBD
keywords: [discord, telegram, how to, explanation, openbb bot, openbb, guide, bot guide]
---

## Customizing your Bot Experience

OpenBB offers many different customization options for your bot experience. We have two different accounts you can have and it all start by registering at the [OpenBB HUB](https://my.openbb.co)

Once you are registered the next step is linking your account. You can find this under "Linked Platforms" on the Hub Page - an explanation of how to link is provided there.
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/linked+platforms.png" alt="linking platform openBB" width="70%" height="70%" />

Now that your account is linked - lets dive into what you can do.
33 changes: 33 additions & 0 deletions website/content/bot/guides/customizing/individual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Individual
sidebar_position: 3
description: TBD
keywords: [discord, telegram, individual, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide]
---
## 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.

### 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 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

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 or run ```/watchlist``` in your respective platform to configure.

<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/watchlist.png" alt="watchlist openBB" width="70%" height="70%" />

<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/watchlistadd.png" alt="watchlist add openBB" width="70%" height="70%" />

## Server (Discord Only)

42 changes: 42 additions & 0 deletions website/content/bot/guides/customizing/server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Server
sidebar_position: 3
description: TBD
keywords: [discord, telegram, server, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide]
---

## 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 (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. (more to come soon!) Once you set up your account you will be able to query the bot directly in your server like below :

<img src="https://openbb-assets.s3.amazonaws.com/discord/autopost/add.png" alt="autoposting openBB" width="40%" height="40%" />

Or you can manage them at the HUB :
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/autoposting.png" alt="autoposting openBB" width="70%" height="70%" />

We currently offer the following Auto Posting Categories:

| Category | Description | Choices |
| ---- | ----------- | ------- |
| Flow | Options Flow for all stocks | Opening, Golden Sweep, Large, Unusual, Weekly, Above Ask/Below Bid |
| Darkpool | Darkpool Data for the market | Large |
| Heatmap | Overview of the market | S&P 500, Dow Jones 30, NASDAQ 100, Russell 1000, Russell 2000, Crypto, Heatchart |


### 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 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%" />
24 changes: 24 additions & 0 deletions website/content/bot/guides/discord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Discord
sidebar_position: 1
description: TBD
keywords: [discord, how to, explanation, openbb bot, openbb, guide, bot guide]
---

## 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.

To use OpenBB, you need to use slash commands, which are special commands that start with a / symbol. To autoselect commands if you are on Desktop you can hit ```TAB```

You can type / in the chat to see a list of available slash commands for OpenBB Bot. One of the most useful slash commands is /help, which shows you all the commands and how to use them. Some of the most popular commands are:

- ```/cd ticker: AMD``` Shows the daily chart for a given stock ticker.
- ```/c3m ticker: AMD``` Shows the 3-month chart for a given stock ticker.
- ```/flow ticker: AMD``` Shows the recent options flow for the given stock ticker.

That's it! You're ready to explore the market with OpenBB Discord Bot!

Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do!
30 changes: 30 additions & 0 deletions website/content/bot/guides/telegram.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Telegram
sidebar_position: 2
description: TBD
keywords: [telegram, how to, explanation, openbb bot, openbb, guide, bot guide]
---

## 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.

<details><summary>How do I select commands instead of typing?</summary>
If you are On mobile press and hold to select the command.

On desktop press ```tab``` to select the command.
</details>


To see all the available commands, you can type ```/help``` in the chat. This will show you a list of commands and their descriptions. You can also tap on any command to use it directly. Some of the most popular commands are:

- ```/cd AMD``` Shows the daily chart for a given stock ticker.
- ```/c3m AMD``` Shows the 3-month chart for a given stock ticker.
- ```/flow AMD``` Shows the recent options flow for the given stock ticker.
- ```/c DOGE``` Shows a chart for the crypto symbol provided.

That's it! You're ready to use OpenBB Telegram Bot and explore the markets. Have fun!

Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do!
4 changes: 2 additions & 2 deletions website/content/bot/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To add the bot to your server click on one of the links for your respective plat

---

# Discord - First Time Setup
## Discord - First Time Setup

A pop-up window will open, asking you to log in to your Discord account and allow the bot access.

Expand All @@ -34,7 +34,7 @@ Congratulations! You’ve successfully added a bot to your Discord server.

---

# Telegram - First Time Setup
## Telegram - First Time Setup

After clicking on the Add to Telegram button it should open a chat with our OpenBB Bot.

Expand Down
100 changes: 0 additions & 100 deletions website/content/bot/reference/discord/alerts.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions website/content/bot/reference/discord/alerts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Alerts

- [create](/bot/reference/discord/alerts/create)
- [delete](/bot/reference/discord/alerts/delete)
- [list](/bot/reference/discord/alerts/list)
- [update](/bot/reference/discord/alerts/update)
5 changes: 5 additions & 0 deletions website/content/bot/reference/discord/autopost/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Autopost

- [add](/bot/reference/discord/autopost/add)
- [list](/bot/reference/discord/autopost/list)
- [remove](/bot/reference/discord/autopost/remove)
Loading

0 comments on commit c363019

Please sign in to comment.