-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use OpenAI API to improve bot-discord docs (#4657)
* Use OpenAI API to improve bot-discord docs * almost done..... * last edits * final fixes with updated index * spacing --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
- Loading branch information
Showing
310 changed files
with
5,040 additions
and
5,009 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,40 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: create | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# create | ||
|
||
Create an alert with conditions for a symbol | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts create ticker condition price | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| ticker | Ticker to set alert for | False | None | | ||
| condition | Condition to set alert for | False | Equal or Above, Equal or Below | | ||
| price | Price to set alert for | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts create ticker:BTCUSD condition:Equal or Above price:1000 | ||
``` | ||
|
||
``` | ||
/alerts create ticker:SPY condition:Equal or Below price:400 | ||
``` | ||
|
||
--- | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: create | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# create | ||
|
||
This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal to or above the user defined price. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts create ticker condition price | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| ticker | Ticker to set alert for | False | None | | ||
| condition | Condition to set alert for | False | Equal or Above, Equal or Below | | ||
| price | Price to set alert for | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts create ticker:BTCUSD condition:Equal or Above price:1000 | ||
``` | ||
|
||
``` | ||
/alerts create ticker:SPY condition:Equal or Below price:400 | ||
``` | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,34 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: delete | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# delete | ||
|
||
Delete an active alert you have set | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts delete alert | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| alert | Alert to delete | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts delete alert: | ||
``` | ||
|
||
--- | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: delete | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# delete | ||
|
||
This command allows the user to delete an active alert they have set. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts delete alert | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| alert | Alert to delete | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts delete alert: | ||
``` | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,32 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: list | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# list | ||
|
||
List all of your active alerts | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts list | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts list | ||
``` | ||
--- | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: list | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# list | ||
|
||
This command allows the user to view a list of all their active alerts. It displays each alert along with its symbol, description, and threshold, giving the user an overview of their active alerts at a glance. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts list | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts list | ||
``` | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,36 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: update | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# update | ||
|
||
Update a condition on an active alert | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts update alerts condition price | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| alerts | Your active alerts | False | None | | ||
| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) | | ||
| price | Update alert to this price | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts update alerts: condition: price: | ||
``` | ||
|
||
--- | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: update | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# update | ||
|
||
This command allows the user to update the condition on an active alert, such as changing the value of a price alert. The command will update the alert with the new condition and keep the alert active until it is manually deactivated or the alert's condition is met. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/alerts update alerts condition price | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| alerts | Your active alerts | False | None | | ||
| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) | | ||
| price | Update alert to this price | False | None | | ||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/alerts update alerts: condition: price: | ||
``` | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,32 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: add | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# add | ||
|
||
Add an autopost webhook feed to this channel. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/autopost add | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/autopost add | ||
``` | ||
--- | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: add | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# 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. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/autopost add | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/autopost add | ||
``` | ||
--- |
Oops, something went wrong.