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

[Docs] Upgrade Docusaurus to v3 #6386

Merged
merged 9 commits into from
May 10, 2024
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
68 changes: 39 additions & 29 deletions website/content/bot/faqs.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,86 @@
---
title: FAQs
sidebar_position: 5
description: This page offers information about OpenBB Bot, covering topics such as
description:
This page offers information about OpenBB Bot, covering topics such as
linking your OpenBB Bot account, trying an OpenBB Bot plan, automatic plan renewals,
refunds, access on different platforms, individual and server plans, and troubleshooting
issues with slash commands.
keywords:
- OpenBB Bot
- OpenBB Bot account
- OpenBB plan
- billing cycle
- OpenBB Discord
- server settings
- integrations
- refunds
- subscription
- individual plan
- server plan
- slash commands
- OpenBB Bot
- OpenBB Bot account
- OpenBB plan
- billing cycle
- OpenBB Discord
- server settings
- integrations
- refunds
- subscription
- individual plan
- server plan
- slash commands
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import HeadTitle from "@site/src/components/General/HeadTitle.tsx";

<HeadTitle title="FAQs | OpenBB Bot Docs" />

<details><summary>How Do I Link My OpenBB Bot Account?</summary>
<details>
<summary mdxType="summary">How Do I Link My OpenBB Bot Account?</summary>

After you signup for an OpenBB Bot plan you can link your accounts from <a href="https://my.openbb.co/app/bot" class="_hyper-link">here</a>

</details>

<details><summary>Can I try an OpenBB Bot plan?</summary>
<details>
<summary mdxType="summary">Can I try an OpenBB Bot plan?</summary>

You can try a preview of any plan by just running commands on a server that has OpenBB Bot, like <a href='https://my.openbb.co/discord' class='_hyper-link'>OpenBB Discord</a>. We offer a limited amount of daily commands.

</details>


<details><summary>Will my OpenBB Bot plan renew at the end of the billing cycle?</summary>
<details>
<summary mdxType="summary">Will my OpenBB Bot plan renew at the end of the billing cycle?</summary>

Yes, plans renew automatically at the end of the monthly and yearly billing cycles. You can cancel your plan at any time, before the end of the billing cycle, and it will not auto-renew anymore.

</details>


<details><summary>Can I get a refund on my OpenBB Bot?</summary>
<details>
<summary mdxType="summary">Can I get a refund on my OpenBB Bot?</summary>

Since we offer a free command tier to try commands we don't offer refunds as you have had ample time to try the service and make a decision.

</details>


<details><summary>If I sign up for OpenBB Bot do I get access on all platforms?</summary>
<details>
<summary mdxType="summary">If I sign up for OpenBB Bot do I get access on all platforms?</summary>

Yes! You will have access on Discord, and other platforms as we add support.

</details>

<details><summary>If I cancel OpenBB Bot subscription do I still have access?</summary>
<details>
<summary mdxType="summary">If I cancel OpenBB Bot subscription do I still have access?</summary>

No, you will lose your access but you get a credit on your account of the prorated amount until the end of your current billing cycle.

</details>


<details><summary>What's the difference between an individual plan and server plan on OpenBB Bot?</summary>
<details>
<summary mdxType="summary">What's the difference between an individual plan and server plan on OpenBB Bot?</summary>

An individual plan gives your account access to OpenBB Bot while a server plan gives the whole server access. An individual plan carries more perks with it than a server plan, which you can find by clicking on the plan.

</details>

<details>
<summary mdxType="summary">I added the bot but still don't see slash commands, what do I do?</summary>

<details><summary>I added the bot but still don't see slash commands, what do I do?</summary>

<img class="mb-8" src="https://assets-global.website-files.com/5f9072399b2640f14d6a2bf4/625ddbedd330d37960463537_Untitled.png" />
<img
class="mb-8"
src="https://assets-global.website-files.com/5f9072399b2640f14d6a2bf4/625ddbedd330d37960463537_Untitled.png"
/>

Just head to <b>Server Settings → Integrations</b> and then <b>click ‘Manage’ next to an app</b>, where you will behold a new, shiny, and dare we say <i>dazzling</i>, new surface.

Expand All @@ -83,8 +90,11 @@ Just head to <b>Server Settings → Integrations</b> and then <b>click ‘Manage
</ul>

There’s also a command-specific list, where you can make customized permissions for each command.

<ul class="list-disc my-4 ml-4">
<li>By default, these are all synced to the command permission at the top.</li>
<li>
By default, these are all synced to the command permission at the top.
</li>
<li>You can unsync an individual command to make further customizations.</li>
</ul>

Expand Down
47 changes: 25 additions & 22 deletions website/content/bot/usage/telegram.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
title: Telegram
sidebar_position: 2
description: A complete guide on how to use the OpenBB Telegram Bot for stock and
description:
A complete guide on how to use the OpenBB Telegram Bot for stock and
crypto market exploration. Learn how to use slash commands, including /cd, /c3m,
/flow, and /c for market insights.
keywords:
- Telegram
- /cd command
- /c3m command
- /flow command
- /c command
- OpenBB Telegram Bot
- stock ticker
- crypto symbol
- market exploration
- using bots
- Telegram commands
- Telegram
- /cd command
- /c3m command
- /flow command
- /c command
- OpenBB Telegram Bot
- stock ticker
- crypto symbol
- market exploration
- using bots
- Telegram commands
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Expand All @@ -24,7 +25,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

<div className="flex justify-center h-full w-[800px] rounded-r-[4px]">
<img
Expand All @@ -34,20 +35,22 @@ To use it, you need to type slash commands in the chat. A slash command starts w
/>
</div>

<details><summary>How do I select commands instead of typing?</summary>
<details>
<summary mdxType="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>
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:
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.
- `/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!
Check out the Reference section for more commands or type `/help` in your chat to see what else we can do!
15 changes: 8 additions & 7 deletions website/content/excel/data-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ title: Data connectors
sidebar_position: 3
description: Access your data connectors from OpenBB Terminal Pro inside OpenBB Add-in for Excel.
keywords:
- Microsoft Excel
- Add-in
- Advanced
- Data connectors
- BYOD
- Bring your own data
- Microsoft Excel
- Add-in
- Advanced
- Data connectors
- BYOD
- Bring your own data
---

<!-- markdownlint-disable MD033 -->

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Data connectors | OpenBB Add-in for Excel Docs" />
Expand Down Expand Up @@ -48,7 +49,7 @@ The easiest way to pass optional parameters is to write them into cells and refe

:::info

- Make sure your backend's CORS settings allow requests coming from <https://excel.openbb.co>.
- Make sure your backend's CORS settings allow requests coming from [https://excel.openbb.co](https://excel.openbb.co).
- Requests via HTTP will be blocked by Excel. So if you are using the Add-in for Excel on Mac or Office on the web with Safari browser you need to run your backend via HTTPS.

:::
Expand Down
30 changes: 15 additions & 15 deletions website/content/excel/getting-started/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Basics
sidebar_position: 2
description: This page provides an overview of the basics of the OpenBB add-in for Microsoft Excel. It covers the basic usage of the add-in and the available functions.
keywords:
- Microsoft Excel
- Add-in
- Basics
- Examples
- Functions
- Microsoft Excel
- Add-in
- Basics
- Examples
- Functions
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Expand All @@ -19,28 +19,28 @@ The OpenBB Add-in for Excel provides direct access to the OpenBB platform, where
- `OBB.[MENU].[SUB_MENU].[COMMAND]`

:::tip
Use the <TAB\> key to autocomplete the function name after typing `=OBB.`
Use the &lt;TAB&gt; key to autocomplete the function name after typing `=OBB.`
:::

Examples:

1. Getting balance sheet data for a stock:

```excel
=OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL")
```
```excel
=OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL")
```

2. Getting the latest news for a stock:

```excel
=OBB.NEWS.COMPANY("AAPL")
```
```excel
=OBB.NEWS.COMPANY("AAPL")
```

3. Getting the earnings calendar:

```excel
=OBB.EQUITY.CALENDAR.IPO(,"2023-11-20")
```
```excel
=OBB.EQUITY.CALENDAR.IPO(,"2023-11-20")
```

:::tip
If you want to skip a parameter use comma (or semi-colon depending on your number separator) without any value. In example iii. we are skipping the first parameter (symbol).
Expand Down
43 changes: 21 additions & 22 deletions website/content/excel/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,56 @@ title: Help
sidebar_position: 5
description: Help for OpenBB Add-in for Excel.
keywords:
- Microsoft Excel
- Add-in
- Help
- Microsoft Excel
- Add-in
- Help
---

<!-- markdownlint-disable MD033 -->
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import HeadTitle from "@site/src/components/General/HeadTitle.tsx";

<HeadTitle title="Help | Get help" />

If you face specific issues while using the add-in and the solutions provided here don't resolve them, don't hesitate to reach out to us for further assistance. You can contact us through <support@openbb.finance>.
If you face specific issues while using the add-in and the solutions provided here don't resolve them, don't hesitate to reach out to us for further assistance. You can contact us through [support@openbb.finance](mailto:support@openbb.finance).

<details>
<summary>Running an OBB. function returns '#VALUE!'</summary>
<summary mdxType="summary">Running an OBB. function returns '#VALUE!'</summary>

* Make sure you are using the correct syntax for the function. You can find the correct syntax for each function [here](https://docs.openbb.co/excel/reference)
* If you have just opened your workbook and the OBB. function returns '#VALUE!', try recalculating the cell again - this is an ongoing issue with Excel add-ins
- Make sure you are using the correct syntax for the function. You can find the correct syntax for each function [here](https://docs.openbb.co/excel/reference)
- If you have just opened your workbook and the OBB. function returns '#VALUE!', try recalculating the cell again - this is an ongoing issue with Excel add-ins

</details>

<details>
<summary>OBB. functions are not available after installing the add-in</summary>
<summary mdxType="summary">OBB. functions are not available after installing the add-in</summary>

* Make sure OpenBB Add-in for Excel shows in the ribbon
* Go to **Insert** > **Get Add-ins** > **My Add-ins** > Click '...' when hovering OpenBB add-in > remove the add-in and install it again
* Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)
- Make sure OpenBB Add-in for Excel shows in the ribbon
- Go to **Insert** > **Get Add-ins** > **My Add-ins** > Click '...' when hovering OpenBB add-in > remove the add-in and install it again
- Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)

</details>

<details>
<summary>Task pane displays "You don’t have permission to use this add-in. Contact your system administrator to request access."</summary>
<summary mdxType="summary">Task pane displays "You don’t have permission to use this add-in. Contact your system administrator to request access."</summary>

* Make sure your account has the necessary permissions to use add-in
* Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)
- Make sure your account has the necessary permissions to use add-in
- Restart your computer or manually [clear the Office cache](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache)

</details>

<details>
<summary>Editing a workbook in the browser and then on desktop app duplicates the 'OpenBB' tab in the ribbon</summary>
<summary mdxType="summary">Editing a workbook in the browser and then on desktop app duplicates the 'OpenBB' tab in the ribbon</summary>

This is a known Excel issue. Currently, there is no definitive fix for the problem, but there are workarounds you can apply to fix the file depending on your operating system:

* **Windows**: File > Info > Inspect Workbook > Check ‘Task Pane Add-ins’ > Click ‘OK’. This will scan your workbook and remove the stale add-in reference created by Excel in the browser
* **Mac**: rename your file from .xlsx to .zip > unzip it using WinZip for Mac (don’t use the default unzip tool, otherwise it won’t work) > look for webextensions folder and delete webextension1.xml > rename the file back to .xlsx
- **Windows**: File > Info > Inspect Workbook > Check ‘Task Pane Add-ins’ > Click ‘OK’. This will scan your workbook and remove the stale add-in reference created by Excel in the browser
- **Mac**: rename your file from .xlsx to .zip > unzip it using WinZip for Mac (don’t use the default unzip tool, otherwise it won’t work) > look for webextensions folder and delete webextension1.xml > rename the file back to .xlsx

</details>

<details>
<summary>Cannot retrieve the data added to Terminal Pro through custom backend using OBB.BYOD</summary>
<summary mdxType="summary">Cannot retrieve the data added to Terminal Pro through custom backend using OBB.BYOD</summary>

* Make sure your backend is running and accessible
* If you are using Mac or Safari make sure your backend is using HTTPS and has a valid SSL certificate
- Make sure your backend is running and accessible
- If you are using Mac or Safari make sure your backend is using HTTPS and has a valid SSL certificate

</details>
Loading
Loading