Skip to content

Commit

Permalink
add new bot command autopost docs (#5530)
Browse files Browse the repository at this point in the history
add new bot command autopost docs to docs.openbb.co

Co-authored-by: James Maslek <jmaslek11@gmail.com>
  • Loading branch information
andrewkenreich and jmaslek authored Oct 11, 2023
1 parent dac1085 commit 16d29d6
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 61 deletions.
24 changes: 15 additions & 9 deletions website/content/bot/reference/discord/autopost/add.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: add
title: commands add
description: OpenBB Discord Command
---

# add
# commands add

This command allows the user to add an autopost webhook feed to a channel. It allows the user to receive notifications from OpenBB webhooks in the channel without having to manually post them. This can be used to keep track of flow, darkpool, market heatmap and more.
This command allows the user to add an autopost command to a channel. It allows the user to receive notifications from OpenBB bot in the channel without having to manually query them. This can be used for all commands that appear in the list when you run "autopost commands add"

### Usage

```python wordwrap
/autopost add
/autopost commands add cmd interval [start_time] [stop_time]
```

---

## Parameters

This command has no parameters


| Name | Description | Optional | Choices |
| ---- | ----------- | -------- | ------- |
| cmd | Pick the command you want to assign for autoposting | False | List of commands that allow auto posting |
| interval | How oftern to post the autopost command | False | 5m, 15m, 30m, 1hr, 2hr, 4hr, 6hr |
| start_time | Time to start the autopost command - ex. If I want to start at 8am I do 8 | True | 24hr time |
| stop_time | Time to stop the autopost command - ex. If I want to stop at 6pm I do 18 | True | 24hr time |

---

## Examples

```
/autopost add
/autopost commands add cmd:/cm interval:1 Hour
```

```
/autopost commands add cmd: /cm interval: 1 Hour start_time: 9 stop_time: 10
```
---
39 changes: 39 additions & 0 deletions website/content/bot/reference/discord/autopost/feeds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: feeds
description: OpenBB Discord Command
---

# feeds

This command allows the user to add, remove, or list autopost webhook feeds to a channel. It allows the user to receive notifications from OpenBB webhooks in the channel without having to manually post them. This can be used to keep track of flow, darkpool, and market heatmaps.


### Usage

```python wordwrap
/autopost feeds action
```

---

## Parameters

| Name | Description | Optional | Choices |
| ---- | ----------- | -------- | ------- |
| action | Add, Remove, or List your feeds for Discord autoposts | False | Add, Remove, List |


## Examples

```
/autopost feeds action:Add
```

```
/autopost feeds action:List
```

```
/autopost feeds action:Remove
```
18 changes: 9 additions & 9 deletions website/content/bot/reference/discord/autopost/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard";
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">

<ReferenceCard
title="add"
description="This command allows the user to add an autopost webhook feed to a channel. It allows the user to receive..."
url="/bot/reference/discord/autopost/add"
title="feeds"
description="This command allows you to manage your autopost feeds 'flow, darkpool, or heatmap'"
url="/bot/reference/discord/autopost/feeds"
/>
<ReferenceCard
title="list"
description="This command allows users to view all webhook feeds associated with a particular channel that have been set up..."
url="/bot/reference/discord/autopost/list"
title="commands add"
description="Allows you to add a bot command as an autopost (different from feed)"
url="/bot/reference/discord/autopost/add"
/>
<ReferenceCard
title="remove"
description="This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove..."
url="/bot/reference/discord/autopost/remove"
title="commands manage"
description="Allows you to remove or list your bot command autoposts in a channel"
url="/bot/reference/discord/autopost/manage"
/>
</ul>
32 changes: 0 additions & 32 deletions website/content/bot/reference/discord/autopost/list.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: remove
title: commands manage
description: OpenBB Discord Command
---

# remove
# commands manage

This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent.

### Usage

```python wordwrap
/autopost remove
/autopost commands manage action
```

---

## Parameters

This command has no parameters


| Name | Description | Optional | Choices |
| ---- | ----------- | -------- | ------- |
| action | Remove, or List your feeds for Discord autoposts | True | Remove, List |

---

## Examples

```
/autopost remove
/autopost commands manage action:List
```
---

```
/autopost commands manage action:Remove
```

25 changes: 22 additions & 3 deletions website/content/bot/usage/customizing/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ The Server plan for OpenBB Bot offers three different capabilities - Charting, B

## Server

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

<img src="https://openbb-assets.s3.amazonaws.com/discord/autopost/add.png" alt="autoposting openBB" width="40%" height="40%" />
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/autopost.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%" />
Expand All @@ -46,6 +46,25 @@ For a further breakdown on what each Flow Auto Post entails - See below
| Buy to Open | "Premium > $1,000,000" & "Volume > Open Interest" & "Trade Type is Above Ask" |
| Whale | "Premium > $1.000,000" & "Days to Expiration < 45" |


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

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/docs/bot_docs/commands+add.png" alt="commands add openBB" width="40%" height="40%" />

Commands as autoposts are a great way to get your community the info they need in a timely manner.

We have allowed even more autoposts to be set up in your server so you can really create a fun environment for all your needs:
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/autopost+list.png" alt="autopost list openBB" width="40%" height="40%" />

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/earnings+example.png" alt="earnings command autopost openBB" width="40%" height="40%" />

<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/flow+example.png" alt="earnings command autopost openBB" width="40%" height="40%" />

### 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).
Expand Down

0 comments on commit 16d29d6

Please sign in to comment.