Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use OpenAI API to improve bot-discord docs #4657

Merged
merged 7 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
80 changes: 40 additions & 40 deletions website/content/bot/reference/discord/alerts/create.md
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
```

---
68 changes: 34 additions & 34 deletions website/content/bot/reference/discord/alerts/delete.md
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:
```

---
8 changes: 4 additions & 4 deletions website/content/bot/reference/discord/alerts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard";

<ReferenceCard
title="create"
description="Create an alert with conditions for a symbol"
description="This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal..."
url="/bot/reference/discord/alerts/create"
/>
<ReferenceCard
title="delete"
description="Delete an active alert you have set"
description="This command allows the user to delete an active alert they have set."
url="/bot/reference/discord/alerts/delete"
/>
<ReferenceCard
title="list"
description="List all of your active alerts"
description="This command allows the user to view a list of all their active alerts. It displays each alert along with its..."
url="/bot/reference/discord/alerts/list"
/>
<ReferenceCard
title="update"
description="Update a condition on an active alert"
description="This command allows the user to update the condition on an active alert, such as changing the value of a price..."
url="/bot/reference/discord/alerts/update"
/>
</ul>
64 changes: 32 additions & 32 deletions website/content/bot/reference/discord/alerts/list.md
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
```
---
72 changes: 36 additions & 36 deletions website/content/bot/reference/discord/alerts/update.md
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:
```

---
64 changes: 32 additions & 32 deletions website/content/bot/reference/discord/autopost/add.md
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
```
---
Loading