From 2754be26203f7a1c2fc7491db3b5a9fbce291859 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Thu, 6 Apr 2023 18:50:45 -0700 Subject: [PATCH] Improve overall docusaurus (#4675) * Improve overall docusaurus * update pypi on installation * fix merge conflicts * fix spelling * change CRLF to LF * improve docs installation for bot * more changes * few more * fix --------- Co-authored-by: andrewkenreich --- website/content/bot/Installation/index.md | 25 ++++-- .../content/bot/changelog/version1_0_0.mdx | 4 +- .../content/bot/changelog/version1_0_1.mdx | 4 +- .../content/bot/changelog/version1_0_2.mdx | 4 +- .../content/bot/changelog/version1_0_3.mdx | 4 +- .../content/bot/changelog/version1_0_4.mdx | 4 +- .../content/bot/changelog/version1_0_5.mdx | 4 +- .../content/bot/changelog/version1_0_6.mdx | 4 +- .../content/bot/changelog/version1_0_7.mdx | 4 +- .../content/bot/changelog/version1_0_8.mdx | 4 +- .../content/bot/changelog/version2_0_0.mdx | 4 +- website/content/bot/guides/_category_.json | 4 - .../content/bot/guides/customizing/index.md | 15 ---- website/content/bot/installation/discord.md | 7 +- website/content/bot/installation/telegram.md | 8 +- website/content/bot/reference/_category_.json | 2 +- .../bot/reference/discord/flow/index.mdx | 2 +- .../bot/reference/discord/flow/opening.md | 2 +- .../bot/reference/telegram/charts/c.md | 84 +++++++++---------- .../bot/reference/telegram/charts/c15m.md | 68 +++++++-------- .../bot/reference/telegram/charts/c3m.md | 78 ++++++++--------- .../bot/reference/telegram/charts/c5m.md | 78 ++++++++--------- .../bot/reference/telegram/charts/cc.md | 70 ++++++++-------- .../bot/reference/telegram/charts/cd.md | 68 +++++++-------- .../bot/reference/telegram/charts/chart.md | 80 +++++++++--------- .../bot/reference/telegram/charts/chartfib.md | 68 +++++++-------- .../bot/reference/telegram/charts/chartsr.md | 78 ++++++++--------- .../bot/reference/telegram/charts/cm.md | 68 +++++++-------- .../bot/reference/telegram/charts/cw.md | 68 +++++++-------- .../reference/telegram/crypto/bigprints.md | 70 ++++++++-------- .../bot/reference/telegram/crypto/bio.md | 68 +++++++-------- .../bot/reference/telegram/crypto/compfees.md | 76 ++++++++--------- .../bot/reference/telegram/crypto/defi.md | 74 ++++++++-------- .../bot/reference/telegram/crypto/fees.md | 68 +++++++-------- .../bot/reference/telegram/crypto/ir.md | 66 +++++++-------- .../bot/reference/telegram/crypto/prints.md | 68 +++++++-------- .../bot/reference/telegram/crypto/top.md | 80 +++++++++--------- .../bot/reference/telegram/crypto/tvl.md | 74 ++++++++-------- .../reference/telegram/darkpool/allblocks.md | 68 +++++++-------- .../bot/reference/telegram/darkpool/alldp.md | 68 +++++++-------- .../reference/telegram/darkpool/allprints.md | 68 +++++++-------- .../telegram/darkpool/bigprintsdp.md | 68 +++++++-------- .../bot/reference/telegram/darkpool/levels.md | 70 ++++++++-------- .../reference/telegram/darkpool/sectors.md | 70 ++++++++-------- .../reference/telegram/darkpool/summary.md | 70 ++++++++-------- .../bot/reference/telegram/darkpool/topsum.md | 64 +++++++------- .../reference/telegram/discovery/arktrades.md | 62 +++++++------- .../reference/telegram/discovery/fgindex.md | 62 +++++++------- .../bot/reference/telegram/discovery/halts.md | 64 +++++++------- .../reference/telegram/discovery/holidays.md | 62 +++++++------- .../reference/telegram/discovery/ipolist.md | 66 +++++++-------- .../bot/reference/telegram/discovery/pop.md | 68 +++++++-------- .../telegram/discovery/trendingst.md | 66 +++++++-------- .../bot/reference/telegram/discovery/wsb.md | 66 +++++++-------- .../bot/reference/telegram/duediligence/ah.md | 68 +++++++-------- .../telegram/duediligence/analyst.md | 68 +++++++-------- .../telegram/duediligence/bio_stocks.md | 68 +++++++-------- .../telegram/duediligence/customer.md | 70 ++++++++-------- .../telegram/duediligence/divinfo.md | 68 +++++++-------- .../telegram/duediligence/earnings.md | 68 +++++++-------- .../reference/telegram/duediligence/ermove.md | 68 +++++++-------- .../telegram/duediligence/financials.md | 68 +++++++-------- .../telegram/duediligence/insiders.md | 68 +++++++-------- .../telegram/duediligence/instholdings.md | 68 +++++++-------- .../reference/telegram/duediligence/nexter.md | 68 +++++++-------- .../bot/reference/telegram/duediligence/pm.md | 68 +++++++-------- .../bot/reference/telegram/duediligence/pt.md | 66 +++++++-------- .../reference/telegram/duediligence/sec.md | 66 +++++++-------- .../reference/telegram/duediligence/splits.md | 68 +++++++-------- .../telegram/duediligence/supplier.md | 68 +++++++-------- .../reference/telegram/duediligence/ytd.md | 68 +++++++-------- .../bot/reference/telegram/economy/bonds.md | 68 +++++++-------- .../reference/telegram/economy/calendar.md | 62 +++++++------- .../reference/telegram/economy/commodities.md | 66 +++++++-------- .../reference/telegram/economy/currencies.md | 66 +++++++-------- .../reference/telegram/economy/fedrates.md | 66 +++++++-------- .../bot/reference/telegram/economy/indices.md | 66 +++++++-------- .../bot/reference/telegram/economy/revrepo.md | 76 ++++++++--------- .../reference/telegram/economy/yieldcurve.md | 62 +++++++------- .../bot/reference/telegram/etf/holdings.md | 66 +++++++-------- .../bot/reference/telegram/etf/tops.md | 66 +++++++-------- .../bot/reference/telegram/flow/bigflow.md | 66 +++++++-------- .../bot/reference/telegram/flow/flow/day.md | 82 +++++++++--------- .../reference/telegram/flow/flow/index.mdx | 2 +- .../bot/reference/telegram/flow/flow/open.md | 66 +++++++-------- .../bot/reference/telegram/flow/flow/prem.md | 68 +++++++-------- .../bot/reference/telegram/flow/flow/unu.md | 66 +++++++-------- .../bot/reference/telegram/flow/flow/wk.md | 68 +++++++-------- .../reference/telegram/flow/flowsum/day.md | 68 +++++++-------- .../reference/telegram/flow/flowsum/exp.md | 70 ++++++++-------- .../reference/telegram/flow/flowsum/top.md | 66 +++++++-------- .../bot/reference/telegram/flow/flowsum/wk.md | 66 +++++++-------- .../reference/telegram/flow/sectorsflow.md | 76 ++++++++--------- .../reference/telegram/flow/summaryflow.md | 76 ++++++++--------- .../bot/reference/telegram/fun/8ball.md | 68 +++++++-------- .../bot/reference/telegram/fun/flip.md | 66 +++++++-------- .../bot/reference/telegram/fun/urban.md | 66 +++++++-------- .../bot/reference/telegram/general/news.md | 66 +++++++-------- .../bot/reference/telegram/general/quote.md | 66 +++++++-------- .../bot/reference/telegram/general/ta.md | 66 +++++++-------- .../telegram/government/contracts.md | 66 +++++++-------- .../reference/telegram/government/house.md | 66 +++++++-------- .../reference/telegram/government/senate.md | 66 +++++++-------- .../bot/reference/telegram/info/about.md | 64 +++++++------- .../bot/reference/telegram/info/start.md | 62 +++++++------- .../bot/reference/telegram/options/chains.md | 82 +++++++++--------- .../reference/telegram/options/equitypc.md | 64 +++++++------- .../bot/reference/telegram/options/gamma.md | 78 ++++++++--------- .../bot/reference/telegram/options/highiv.md | 64 +++++++------- .../bot/reference/telegram/options/hist.md | 78 ++++++++--------- .../bot/reference/telegram/options/indexpc.md | 64 +++++++------- .../bot/reference/telegram/options/itm.md | 68 +++++++-------- .../bot/reference/telegram/options/iv.md | 66 +++++++-------- .../bot/reference/telegram/options/maxpain.md | 68 +++++++-------- .../bot/reference/telegram/options/oi.md | 76 ++++++++--------- .../bot/reference/telegram/options/oichart.md | 76 ++++++++--------- .../bot/reference/telegram/options/opstats.md | 66 +++++++-------- .../bot/reference/telegram/options/smile.md | 78 ++++++++--------- .../bot/reference/telegram/options/topoi.md | 64 +++++++------- .../reference/telegram/options/topoichange.md | 64 +++++++------- .../telegram/options/topstrikevol.md | 68 +++++++-------- .../bot/reference/telegram/options/topvol.md | 64 +++++++------- .../reference/telegram/options/topvoletf.md | 64 +++++++------- .../bot/reference/telegram/options/unu.md | 64 +++++++------- .../reference/telegram/options/uoastock.md | 72 ++++++++-------- .../bot/reference/telegram/options/vol.md | 76 ++++++++--------- .../bot/reference/telegram/options/vsurf.md | 74 ++++++++-------- .../reference/telegram/overview/heatchart.md | 62 +++++++------- .../reference/telegram/overview/heatmap.md | 76 ++++++++--------- .../reference/telegram/overview/markets.md | 62 +++++++------- .../reference/telegram/overview/watchlist.md | 66 +++++++-------- .../telegram/overview/watchlist_add.md | 66 +++++++-------- .../telegram/overview/watchlist_remove.md | 66 +++++++-------- website/content/bot/usage/_category_.json | 4 + .../content/bot/usage/customizing/index.md | 33 ++++++++ .../customizing/individual.md | 16 +++- .../{guides => usage}/customizing/server.md | 0 .../content/bot/{guides => usage}/discord.md | 14 +++- .../content/bot/{guides => usage}/telegram.md | 10 ++- website/content/sdk/faqs/index.md | 50 +++++++++++ website/content/sdk/usage/_category_.json | 2 +- .../terminal/changelog/version2_0_0.mdx | 6 +- .../terminal/changelog/version2_1_0.mdx | 6 +- .../terminal/changelog/version2_2_0.mdx | 7 +- .../terminal/changelog/version2_3_0.mdx | 6 +- .../terminal/changelog/version2_3_1.mdx | 6 +- .../terminal/changelog/version2_4_0.mdx | 8 +- .../terminal/changelog/version2_4_1.mdx | 8 +- .../terminal/changelog/version2_5_0.mdx | 6 +- .../terminal/changelog/version2_5_1.mdx | 6 +- website/content/terminal/faqs/index.md | 44 ++++++++++ .../content/terminal/installation/index.md | 8 +- .../terminal/reference/_category_.json | 2 +- .../content/terminal/usage/_category_.json | 2 +- .../General/{AddBot.tsx => AddBotDiscord.tsx} | 12 +-- .../src/components/General/AddBotTelegram.tsx | 17 ++++ website/src/components/Icons/Pypi.tsx | 17 ++++ website/src/theme/Navbar/Logo/index.js | 4 +- 158 files changed, 4208 insertions(+), 4021 deletions(-) delete mode 100644 website/content/bot/guides/_category_.json delete mode 100644 website/content/bot/guides/customizing/index.md create mode 100644 website/content/bot/usage/_category_.json create mode 100644 website/content/bot/usage/customizing/index.md rename website/content/bot/{guides => usage}/customizing/individual.md (71%) rename website/content/bot/{guides => usage}/customizing/server.md (100%) rename website/content/bot/{guides => usage}/discord.md (64%) rename website/content/bot/{guides => usage}/telegram.md (84%) create mode 100644 website/content/sdk/faqs/index.md create mode 100644 website/content/terminal/faqs/index.md rename website/src/components/General/{AddBot.tsx => AddBotDiscord.tsx} (79%) create mode 100644 website/src/components/General/AddBotTelegram.tsx create mode 100644 website/src/components/Icons/Pypi.tsx diff --git a/website/content/bot/Installation/index.md b/website/content/bot/Installation/index.md index 0b7de693d2ff..d85caff985f1 100644 --- a/website/content/bot/Installation/index.md +++ b/website/content/bot/Installation/index.md @@ -5,11 +5,26 @@ description: How to get started with OpenBB Bot keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,] --- -import AddBotDialog from "@site/src/components/General/AddBot"; +Currently we support [Discord](Installation/discord) and [Telegram](Installation/telegram) for the OpenBB Bot. More integrations are under way. -## Adding Bot to your Server +In order to use OpenBB Bot in one of these chatting applications you need to either: +
+
    +
  • + Belong to a server that has already added our bot (INDIVIDUAL) +
    • +
  • + Own a server and you can easily add our bot (SERVER) +
    • +
+
-To add the bot to your server click on one of the links for your respective platform and then follow the instructions below. +By using the [Linked Platforms page](https://my.openbb.co/app/bot/linked-platforms) you are also able to link your Discord/Telegram account to the OpenBB Bot and open up even more features. - +

+ What are you waiting for? +

+ +Over 1.5 Million commands have been run on the OpenBB Bot. Join the community and start using OpenBB Bot today! + +Check our user metrics in our [Open page](https://openbb.co/open). diff --git a/website/content/bot/changelog/version1_0_0.mdx b/website/content/bot/changelog/version1_0_0.mdx index b4939833b13d..826754fb4a1b 100644 --- a/website/content/bot/changelog/version1_0_0.mdx +++ b/website/content/bot/changelog/version1_0_0.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.0 +title: v1.0.0 version: "1.0.0" date: 2022-08-03 -description: Version 1.0.0 +description: v1.0.0 sidebar_position: 9 --- diff --git a/website/content/bot/changelog/version1_0_1.mdx b/website/content/bot/changelog/version1_0_1.mdx index 48e42f814247..f26cd3c0007d 100644 --- a/website/content/bot/changelog/version1_0_1.mdx +++ b/website/content/bot/changelog/version1_0_1.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.1 +title: v1.0.1 version: "1.0.1" date: 2022-08-04 -description: Version 1.0.1 +description: v1.0.1 sidebar_position: 8 --- diff --git a/website/content/bot/changelog/version1_0_2.mdx b/website/content/bot/changelog/version1_0_2.mdx index c0eef34a9713..434884f82bac 100644 --- a/website/content/bot/changelog/version1_0_2.mdx +++ b/website/content/bot/changelog/version1_0_2.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.2 +title: v1.0.2 version: "1.0.2" date: 2022-08-05 -description: Version 1.0.2 +description: v1.0.2 sidebar_position: 7 --- diff --git a/website/content/bot/changelog/version1_0_3.mdx b/website/content/bot/changelog/version1_0_3.mdx index 64e8d83dafca..86959c5b98e8 100644 --- a/website/content/bot/changelog/version1_0_3.mdx +++ b/website/content/bot/changelog/version1_0_3.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.3 +title: v1.0.3 version: "1.0.3" date: 2022-08-12 -description: Version 1.0.3 +description: v1.0.3 sidebar_position: 6 --- diff --git a/website/content/bot/changelog/version1_0_4.mdx b/website/content/bot/changelog/version1_0_4.mdx index 3e6d46b90cc2..eb789985587c 100644 --- a/website/content/bot/changelog/version1_0_4.mdx +++ b/website/content/bot/changelog/version1_0_4.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.4 +title: v1.0.4 version: "1.0.4" date: 2022-08-16 -description: Version 1.0.4 +description: v1.0.4 sidebar_position: 5 --- diff --git a/website/content/bot/changelog/version1_0_5.mdx b/website/content/bot/changelog/version1_0_5.mdx index eda1a650cebc..c9f578fb1672 100644 --- a/website/content/bot/changelog/version1_0_5.mdx +++ b/website/content/bot/changelog/version1_0_5.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.5 +title: v1.0.5 version: "1.0.5" date: 2022-08-30 -description: Version 1.0.5 +description: v1.0.5 sidebar_position: 4 --- diff --git a/website/content/bot/changelog/version1_0_6.mdx b/website/content/bot/changelog/version1_0_6.mdx index 724190db17c9..ce01183f5570 100644 --- a/website/content/bot/changelog/version1_0_6.mdx +++ b/website/content/bot/changelog/version1_0_6.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.6 +title: v1.0.6 version: "1.0.6" date: 2022-09-12 -description: Version 1.0.6 +description: v1.0.6 sidebar_position: 3 --- diff --git a/website/content/bot/changelog/version1_0_7.mdx b/website/content/bot/changelog/version1_0_7.mdx index 5ee68aeb660a..3c748ad49f99 100644 --- a/website/content/bot/changelog/version1_0_7.mdx +++ b/website/content/bot/changelog/version1_0_7.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.7 +title: v1.0.7 version: "1.0.7" date: 2022-09-12 -description: Version 1.0.7 +description: v1.0.7 sidebar_position: 2 --- diff --git a/website/content/bot/changelog/version1_0_8.mdx b/website/content/bot/changelog/version1_0_8.mdx index bf801faaf65f..5ade4e84a011 100644 --- a/website/content/bot/changelog/version1_0_8.mdx +++ b/website/content/bot/changelog/version1_0_8.mdx @@ -1,8 +1,8 @@ --- -title: Version 1.0.8 +title: v1.0.8 version: "1.0.8" date: 2022-10-13 -description: Version 1.0.8 +description: v1.0.8 sidebar_position: 1 --- diff --git a/website/content/bot/changelog/version2_0_0.mdx b/website/content/bot/changelog/version2_0_0.mdx index 1a7345f7f17c..285eb4c9bdf4 100644 --- a/website/content/bot/changelog/version2_0_0.mdx +++ b/website/content/bot/changelog/version2_0_0.mdx @@ -1,8 +1,8 @@ --- -title: Current - Version 2.0.0 +title: Current - v2.0.0 version: "2.0.0" date: 2022-10-26 -description: Version 2.0.0 +description: v2.0.0 sidebar_position: 0 --- diff --git a/website/content/bot/guides/_category_.json b/website/content/bot/guides/_category_.json deleted file mode 100644 index 4ffdf06c7ceb..000000000000 --- a/website/content/bot/guides/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Guides", - "position": 3 -} diff --git a/website/content/bot/guides/customizing/index.md b/website/content/bot/guides/customizing/index.md deleted file mode 100644 index fd8d3f6b437f..000000000000 --- a/website/content/bot/guides/customizing/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Customizing -sidebar_position: 3 -description: TBD -keywords: [discord, telegram, how to, explanation, openbb bot, openbb, guide, bot guide] ---- - -## Customizing your Bot Experience - -OpenBB offers many different customization options for your bot experience. We have two different accounts you can have and it all start by registering at the [OpenBB HUB](https://my.openbb.co) - -Once you are registered the next step is linking your account. You can find this under "Linked Platforms" on the Hub Page - an explanation of how to link is provided there. -linking platform openBB - -Now that your account is linked - lets dive into what you can do. diff --git a/website/content/bot/installation/discord.md b/website/content/bot/installation/discord.md index 7b998a795ee2..f424df70c8d8 100644 --- a/website/content/bot/installation/discord.md +++ b/website/content/bot/installation/discord.md @@ -5,9 +5,14 @@ description: How to get started with OpenBB Bot keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,] --- +import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord"; + ## Discord - First Time Setup -A pop-up window will open, asking you to log in to your Discord account and allow the bot access. + + +After clicking on the "Add bot to Discord" button, A pop-up window will open, asking you to log in to your Discord account and allow the bot access. discord bot setup step 1 diff --git a/website/content/bot/installation/telegram.md b/website/content/bot/installation/telegram.md index e8e4051e102d..236747a20429 100644 --- a/website/content/bot/installation/telegram.md +++ b/website/content/bot/installation/telegram.md @@ -4,10 +4,14 @@ sidebar_position: 1 description: How to get started with OpenBB Bot keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,] --- +import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram"; -## Telegram - First Time Setup +## Telegram Server - First Time Setup -After clicking on the Add to Telegram button it should open a chat with our OpenBB Bot. + + +After clicking on the "Add bot to Telegram" button it should open a chat with our OpenBB Bot. telegram bot setup step 1 diff --git a/website/content/bot/reference/_category_.json b/website/content/bot/reference/_category_.json index 12273a39ab79..bde3c6bea188 100644 --- a/website/content/bot/reference/_category_.json +++ b/website/content/bot/reference/_category_.json @@ -1,4 +1,4 @@ { - "label": "Reference", + "label": "Commands", "position": 3 } diff --git a/website/content/bot/reference/discord/flow/index.mdx b/website/content/bot/reference/discord/flow/index.mdx index e8e8c0c58be1..4353b44597cd 100644 --- a/website/content/bot/reference/discord/flow/index.mdx +++ b/website/content/bot/reference/discord/flow/index.mdx @@ -16,7 +16,7 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; /> +
    +
  • + INDIVIDUAL: Allows to customize chart themes, add technical analysis indicators in the chart, create alerts and watchlists +
    • +
  • + SERVER: Allows to customize chart settings, autoposting for members of your server and billboard message (for announcements). +
    • +
+ + +In Order to you customize you will need to link your account. You can find this under [Linked Platforms](https://my.openbb.co/app/bot/linked-platforms) on the Hub Page - an explanation of how to link is provided there. + +
+gif describing step +
+ +Now that your account is linked - lets dive into what you can do on the next pages. diff --git a/website/content/bot/guides/customizing/individual.md b/website/content/bot/usage/customizing/individual.md similarity index 71% rename from website/content/bot/guides/customizing/individual.md rename to website/content/bot/usage/customizing/individual.md index 92c63a23d422..f23e82e3c0ed 100644 --- a/website/content/bot/guides/customizing/individual.md +++ b/website/content/bot/usage/customizing/individual.md @@ -8,6 +8,14 @@ keywords: [discord, telegram, individual, customizing, customization, how to, ex The individual plan offers three different capabilities - Charting, Alerts, and Watchlist. In addition to these benefits you also get unlimited commands per month after registering. +
+ gif describing step +
+ ### Charting Our most popular commands center around the real-time charting capabilities we offer with OpenBB Bot. We allow you to customize many different aspects of your charts when you register with us. You can customize the chart theme and style as well as adding any on and off chart indicators you desire. These settings will apply across all platforms. @@ -23,11 +31,11 @@ Alerts are a powerful tool used by OpenBB users. Simply set the symbol and price ### Watchlist OpenBB Watchlist is a great way to keep track of all your investments in once place. Add Crypto or Stock symbols and quickly see the prices at a glance when its convenient for you. -You can add your tickers through the HUB or run ```/watchlist``` in your respective platform to configure. +You can add your tickers through the [HUB](https://my.openbb.co/app/bot/watchlist) or run ```/watchlist``` in your respective platform to configure. -watchlist openBB +watchlist openBB -watchlist add openBB -## Server (Discord Only) +Customizing the watchlist through the OpenBB Hub : +watchlist add openBB diff --git a/website/content/bot/guides/customizing/server.md b/website/content/bot/usage/customizing/server.md similarity index 100% rename from website/content/bot/guides/customizing/server.md rename to website/content/bot/usage/customizing/server.md diff --git a/website/content/bot/guides/discord.md b/website/content/bot/usage/discord.md similarity index 64% rename from website/content/bot/guides/discord.md rename to website/content/bot/usage/discord.md index dd56f571ba8d..9d57b3f92fda 100644 --- a/website/content/bot/guides/discord.md +++ b/website/content/bot/usage/discord.md @@ -1,19 +1,27 @@ --- title: Discord -sidebar_position: 1 +sidebar_position: 2 description: TBD keywords: [discord, how to, explanation, openbb bot, openbb, guide, bot guide] --- ## Getting Started with Discord -Now that you have added the bot to your discord you can get started with running commands. +Now that you have added the bot to your Discord you can get started with running commands. If you're new to OpenBB Discord Bot, here's a quick guide to get you started. To use OpenBB, you need to use slash commands, which are special commands that start with a / symbol. To autoselect commands if you are on Desktop you can hit ```TAB``` -You can type / in the chat to see a list of available slash commands for OpenBB Bot. One of the most useful slash commands is /help, which shows you all the commands and how to use them. Some of the most popular commands are: +
+ gif describing step +
+ +You can type / in the chat to see a list of available slash commands for OpenBB Bot. One of the most useful slash commands is ```/help```, which shows you all the commands and how to use them. Some of the most popular commands are: - ```/cd ticker: AMD``` Shows the daily chart for a given stock ticker. - ```/c3m ticker: AMD``` Shows the 3-month chart for a given stock ticker. diff --git a/website/content/bot/guides/telegram.md b/website/content/bot/usage/telegram.md similarity index 84% rename from website/content/bot/guides/telegram.md rename to website/content/bot/usage/telegram.md index d38de69cdd80..5e1b5989f1b0 100644 --- a/website/content/bot/guides/telegram.md +++ b/website/content/bot/usage/telegram.md @@ -1,6 +1,6 @@ --- title: Telegram -sidebar_position: 2 +sidebar_position: 3 description: TBD keywords: [telegram, how to, explanation, openbb bot, openbb, guide, bot guide] --- @@ -11,6 +11,14 @@ Now that you have added the bot to your Telegram server you can get started with 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. +
+ gif describing step +
+
How do I select commands instead of typing? If you are On mobile press and hold to select the command. diff --git a/website/content/sdk/faqs/index.md b/website/content/sdk/faqs/index.md new file mode 100644 index 000000000000..187158e7b8eb --- /dev/null +++ b/website/content/sdk/faqs/index.md @@ -0,0 +1,50 @@ +--- +title: FAQs +sidebar_position: 1 +description: Frequently Asked Questions +keywords: + [ + faqs, + questions, + troubleshooting + ] +--- + +import LinkCard from "@site/src/components/General/LinkCard"; + + + + + + + diff --git a/website/content/sdk/usage/_category_.json b/website/content/sdk/usage/_category_.json index 82e09efaafd2..db299faef7fa 100644 --- a/website/content/sdk/usage/_category_.json +++ b/website/content/sdk/usage/_category_.json @@ -1,4 +1,4 @@ { - "label": "Guides", + "label": "Usage", "position": 2 } diff --git a/website/content/terminal/changelog/version2_0_0.mdx b/website/content/terminal/changelog/version2_0_0.mdx index 080a42624939..1f1735182278 100644 --- a/website/content/terminal/changelog/version2_0_0.mdx +++ b/website/content/terminal/changelog/version2_0_0.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.0.0 +title: v2.0.0 version: "2.0.0" date: 2022-11-29 -description: Version 2.0.0 -sidebar_position: 8 +description: v2.0.0 +sidebar_position: 100 --- ## Major Release Notes diff --git a/website/content/terminal/changelog/version2_1_0.mdx b/website/content/terminal/changelog/version2_1_0.mdx index ede8120cf7f9..6ff027351f64 100644 --- a/website/content/terminal/changelog/version2_1_0.mdx +++ b/website/content/terminal/changelog/version2_1_0.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.1.0 +title: v2.1.0 version: "2.1.0" date: 2022-12-21 -description: Version 2.1.0 -sidebar_position: 7 +description: v2.1.0 +sidebar_position: 99 --- ## What's new diff --git a/website/content/terminal/changelog/version2_2_0.mdx b/website/content/terminal/changelog/version2_2_0.mdx index 6dda61fdfd03..4b516bc92157 100644 --- a/website/content/terminal/changelog/version2_2_0.mdx +++ b/website/content/terminal/changelog/version2_2_0.mdx @@ -1,12 +1,11 @@ --- -title: Version 2.2.0 +title: v2.2.0 version: "2.2.0" date: 2022-01-19 -description: Version 2.2.0 -sidebar_position: 6 +description: v2.2.0 +sidebar_position: 98 --- ## What's new Happy new year everyone! Our first release of the year focuses on squashing bugs that were left over from 2022. You may notice now that when loading in a ticker in `stocks`, there is no longer any additional information passed. - diff --git a/website/content/terminal/changelog/version2_3_0.mdx b/website/content/terminal/changelog/version2_3_0.mdx index 0e6725378fa7..a28f8a18d825 100644 --- a/website/content/terminal/changelog/version2_3_0.mdx +++ b/website/content/terminal/changelog/version2_3_0.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.3.0 +title: v2.3.0 version: "2.3.0" date: 2023-01-31 -description: Version 2.3.0 -sidebar_position: 5 +description: v2.3.0 +sidebar_position: 97 --- diff --git a/website/content/terminal/changelog/version2_3_1.mdx b/website/content/terminal/changelog/version2_3_1.mdx index 232f4c2ccb6e..ce1d2fd6d75a 100644 --- a/website/content/terminal/changelog/version2_3_1.mdx +++ b/website/content/terminal/changelog/version2_3_1.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.3.1 +title: v2.3.1 version: "2.3.1" date: 2023-02-01 -description: Version 2.3.1 -sidebar_position: 4 +description: v2.3.1 +sidebar_position: 96 --- ## Fixed diff --git a/website/content/terminal/changelog/version2_4_0.mdx b/website/content/terminal/changelog/version2_4_0.mdx index a32744dbefdb..f32b2ec05a19 100644 --- a/website/content/terminal/changelog/version2_4_0.mdx +++ b/website/content/terminal/changelog/version2_4_0.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.4.0 +title: v2.4.0 version: "2.4.0" date: 2023-02-14 -description: Version 2.4.0 -sidebar_position: 3 +description: v2.4.0 +sidebar_position: 95 --- ## What's new @@ -23,7 +23,7 @@ We have quite a few things added in the last few weeks - Block logout command if no auth enabled (#4233) @montezdesousa - Set guest by default and put authentication behind environment variable (#4197) @montezdesousa - Fix generate_portfolio SDK usage example (#4216) @northern-64bit -- Changed poetry version for docker build (#4229) @luqmanbello +- Changed poetry v for docker build (#4229) @luqmanbello - Feature/general improvements (#4213) @jmaslek - Sunset some dependencies (#4215) @jmaslek - Fix wrongly formatted values on `stocks/fa/cash` (#4211) @hjoaquim diff --git a/website/content/terminal/changelog/version2_4_1.mdx b/website/content/terminal/changelog/version2_4_1.mdx index 4bc98a7e5425..21e540129d24 100644 --- a/website/content/terminal/changelog/version2_4_1.mdx +++ b/website/content/terminal/changelog/version2_4_1.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.4.1 +title: v2.4.1 version: "2.4.1" date: 2023-02-17 -description: Version 2.4.1 -sidebar_position: 2 +description: v2.4.1 +sidebar_position: 94 --- ## What's new @@ -15,7 +15,7 @@ Patches a bug that using `openbb` to launch the terminal avoids loading all data - SDK Added about() for methods and class, fixed pypi.md (#4273) @tehcoderer - Code Coverage (#4236) @luqmanbello - Small typos on readme (#4267) @jose-donato -- Hotfix/SDK Version Dunder (#4269) @tehcoderer +- Hotfix/SDK v Dunder (#4269) @tehcoderer - Bumping to mypy 1.0 (#4198) @jmaslek - Feature/improve docs (#4260) @DidierRLopes - Update SDK Docs Generation (#4262) @tehcoderer diff --git a/website/content/terminal/changelog/version2_5_0.mdx b/website/content/terminal/changelog/version2_5_0.mdx index 1e5869d60114..1ab678479ace 100644 --- a/website/content/terminal/changelog/version2_5_0.mdx +++ b/website/content/terminal/changelog/version2_5_0.mdx @@ -1,9 +1,9 @@ --- -title: Version 2.5.0 +title: v2.5.0 version: "2.5.0" date: 2023-03-01 -description: Version 2.5.0 -sidebar_position: 1 +description: v2.5.0 +sidebar_position: 93 --- diff --git a/website/content/terminal/changelog/version2_5_1.mdx b/website/content/terminal/changelog/version2_5_1.mdx index fbcff18f8739..cc15c1351b1b 100644 --- a/website/content/terminal/changelog/version2_5_1.mdx +++ b/website/content/terminal/changelog/version2_5_1.mdx @@ -1,9 +1,9 @@ --- -title: Current - Version 2.5.1 +title: Current - v2.5.1 version: "2.5.1" date: 2023-03-01 -description: Version 2.5.1 -sidebar_position: 0 +description: Current - v2.5.1 +sidebar_position: 92 --- ## Fixed diff --git a/website/content/terminal/faqs/index.md b/website/content/terminal/faqs/index.md new file mode 100644 index 000000000000..2a14a766ea9a --- /dev/null +++ b/website/content/terminal/faqs/index.md @@ -0,0 +1,44 @@ +--- +title: FAQs +sidebar_position: 1 +description: Frequently Asked Questions +keywords: + [ + faqs, + questions, + troubleshooting + ] +--- + +import LinkCard from "@site/src/components/General/LinkCard"; + + + + + + + diff --git a/website/content/terminal/installation/index.md b/website/content/terminal/installation/index.md index ad224fe50f6e..69d287020d4a 100644 --- a/website/content/terminal/installation/index.md +++ b/website/content/terminal/installation/index.md @@ -36,14 +36,14 @@ import LinkCard from "@site/src/components/General/LinkCard"; /> - - Add bot to Telegram - + ); +} diff --git a/website/src/components/Icons/Pypi.tsx b/website/src/components/Icons/Pypi.tsx new file mode 100644 index 000000000000..1ae79ce54e8f --- /dev/null +++ b/website/src/components/Icons/Pypi.tsx @@ -0,0 +1,17 @@ +import React, { SVGProps } from "react" +interface SVGRProps { + title?: string + titleId?: string +} + +const PypiIcon = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + + +) + +export default PypiIcon diff --git a/website/src/theme/Navbar/Logo/index.js b/website/src/theme/Navbar/Logo/index.js index 39b8d3631197..836da5faf0df 100644 --- a/website/src/theme/Navbar/Logo/index.js +++ b/website/src/theme/Navbar/Logo/index.js @@ -7,6 +7,7 @@ import SDKLetteringLogo from "@site/src/components/Icons/SDKLetteringLogo"; import BotLetteringLogo from "@site/src/components/Icons/BotLetteringLogo"; function getLogo(type) { + /* switch (type) { case "terminal": return ; @@ -16,7 +17,8 @@ function getLogo(type) { return ; default: return ; - } + }*/ + return ; } export default function NavbarLogo() {