From 16d29d62c25b7bef371fd37af007b0722cd8ec30 Mon Sep 17 00:00:00 2001 From: Andrew Date: Wed, 11 Oct 2023 10:21:56 -0400 Subject: [PATCH] add new bot command autopost docs (#5530) add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek --- .../bot/reference/discord/autopost/add.md | 24 +++++++----- .../bot/reference/discord/autopost/feeds.md | 39 +++++++++++++++++++ .../bot/reference/discord/autopost/index.mdx | 18 ++++----- .../bot/reference/discord/autopost/list.md | 32 --------------- .../discord/autopost/{remove.md => manage.md} | 20 ++++++---- .../content/bot/usage/customizing/server.md | 25 ++++++++++-- 6 files changed, 97 insertions(+), 61 deletions(-) create mode 100644 website/content/bot/reference/discord/autopost/feeds.md delete mode 100644 website/content/bot/reference/discord/autopost/list.md rename website/content/bot/reference/discord/autopost/{remove.md => manage.md} (54%) diff --git a/website/content/bot/reference/discord/autopost/add.md b/website/content/bot/reference/discord/autopost/add.md index bbcb3a75bba..69211167f01 100644 --- a/website/content/bot/reference/discord/autopost/add.md +++ b/website/content/bot/reference/discord/autopost/add.md @@ -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 ``` ---- diff --git a/website/content/bot/reference/discord/autopost/feeds.md b/website/content/bot/reference/discord/autopost/feeds.md new file mode 100644 index 00000000000..e6837cf5b55 --- /dev/null +++ b/website/content/bot/reference/discord/autopost/feeds.md @@ -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 +``` diff --git a/website/content/bot/reference/discord/autopost/index.mdx b/website/content/bot/reference/discord/autopost/index.mdx index 91fc999e128..de5c3e78ee2 100644 --- a/website/content/bot/reference/discord/autopost/index.mdx +++ b/website/content/bot/reference/discord/autopost/index.mdx @@ -5,18 +5,18 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/autopost/list.md b/website/content/bot/reference/discord/autopost/list.md deleted file mode 100644 index 1c4d55edb7d..00000000000 --- a/website/content/bot/reference/discord/autopost/list.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: list -description: OpenBB Discord Command ---- - -# list - -This command allows users to view all webhook feeds associated with a particular channel that have been set up for automatic posting. It produces a list of all webhooks that have been configured to post content to the channel automatically, as well as information such as when they are scheduled. - -### Usage - -```python wordwrap -/autopost list -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/autopost list -``` ---- diff --git a/website/content/bot/reference/discord/autopost/remove.md b/website/content/bot/reference/discord/autopost/manage.md similarity index 54% rename from website/content/bot/reference/discord/autopost/remove.md rename to website/content/bot/reference/discord/autopost/manage.md index bccdc79482d..f13103ba320 100644 --- a/website/content/bot/reference/discord/autopost/remove.md +++ b/website/content/bot/reference/discord/autopost/manage.md @@ -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 +``` + diff --git a/website/content/bot/usage/customizing/server.md b/website/content/bot/usage/customizing/server.md index 287d8f2b0e3..3103f4a09c6 100644 --- a/website/content/bot/usage/customizing/server.md +++ b/website/content/bot/usage/customizing/server.md @@ -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 : -autoposting openBB +autoposting openBB Or you can manage them at the HUB : autoposting openBB @@ -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 : +commands add openBB + +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: +autopost list openBB + +Below are a few examples of autoposts set up as commands in a server : + +earnings command autopost openBB + +earnings command autopost openBB + ### 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).