diff options
author | DidierRLopes <dro.lopes@campus.fct.unl.pt> | 2023-11-14 02:17:22 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-14 02:17:22 -0800 |
commit | 963afee549400f174a6066ceb513ee45b36f7208 (patch) | |
tree | eaf01ce9cd32d6c8b7da83ebbc3ca2288bcfddf8 | |
parent | 345c72b864749e54e5410a8ea8b3d77da983d69b (diff) |
Cool cards (#5727)
* tidy up terminal/content
* some more tidy up
* fix styling for platform that was missing
* more tidy up
* improve color for dark and light mode
* create new reference card for more basic cards
* rename back to menus
* implement all index.md for terminal, except reference
* improve bot title
* more refactoring
* fix remaining index
* header styling
* more styling
61 files changed, 624 insertions, 829 deletions
diff --git a/website/content/bot/changelog/index.mdx b/website/content/bot/changelog/index.mdx index 09d847c91c8..5b097fc5ee7 100644 --- a/website/content/bot/changelog/index.mdx +++ b/website/content/bot/changelog/index.mdx @@ -1,57 +1,50 @@ -# changelog +--- +title: Changelog +--- +import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -import ReferenceCard from "@site/src/components/General/ReferenceCard"; +<HeadTitle title="Changelog | OpenBB Bot Docs" /> -<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6"> - -<ReferenceCard - title="v1.0.0" - description="v1.0.0" - url="changelog/v1.0.0" -/> -<ReferenceCard - title="v1.0.1" - description="v1.0.1" - url="changelog/v1.0.1" +<ul className="grid grid-cols-1 gap-4 -ml-6"> +<NewReferenceCard + title="Current - v2.0.0" + url="changelog/version2_0_0" /> -<ReferenceCard - title="v1.0.2" - description="v1.0.2" - url="changelog/v1.0.2" +<NewReferenceCard + title="v1.0.8" + url="changelog/version1_0_8" /> -<ReferenceCard - title="v1.0.3" - description="v1.0.3" - url="changelog/v1.0.3" +<NewReferenceCard + title="v1.0.7" + url="changelog/version1_0_7" /> -<ReferenceCard - title="v1.0.4" - description="v1.0.4" - url="changelog/v1.0.4" +<NewReferenceCard + title="v1.0.6" + url="changelog/version1_0_6" /> -<ReferenceCard +<NewReferenceCard title="v1.0.5" - description="v1.0.5" - url="changelog/v1.0.5" + url="changelog/version1_0_5" /> -<ReferenceCard - title="v1.0.6" - description="v1.0.6" - url="changelog/v1.0.6" +<NewReferenceCard + title="v1.0.4" + url="changelog/version1_0_4" /> -<ReferenceCard - title="v1.0.7" - description="v1.0.7" - url="changelog/v1.0.7" +<NewReferenceCard + title="v1.0.3" + url="changelog/version1_0_3" /> -<ReferenceCard - title="v1.0.8" - description="v1.0.8" - url="changelog/v1.0.8" +<NewReferenceCard + title="v1.0.2" + url="changelog/version1_0_2" /> -<ReferenceCard - title="Current - v2.0.0" - description="v2.0.0" - url="changelog/Current - v2.0.0" +<NewReferenceCard + title="v1.0.1" + url="changelog/version1_0_1" +/> +<NewReferenceCard + title="v1.0.0" + url="changelog/version1_0_0" /> </ul> diff --git a/website/content/bot/faqs.md b/website/content/bot/faqs.md index 3fe16bbf419..f2b1a07d40f 100644 --- a/website/content/bot/faqs.md +++ b/website/content/bot/faqs.md @@ -24,8 +24,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; <HeadTitle title="FAQs | OpenBB Bot Docs" /> -## Generic - <details><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> diff --git a/website/content/bot/index.mdx b/website/content/bot/index.mdx deleted file mode 100644 index 08dce815d0f..00000000000 --- a/website/content/bot/index.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# OpenBB Bot Reference - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6"> - -<ReferenceCard - title="Changelog" - description="version1_0_0, version1_0_1, version1_0_2, version1_0_3, version1_0_4, version1_0_5, version1_0_6, version1_0_7, version1_0_8, version2_0_0" - url="bot/changelog" - /> -<ReferenceCard - title="Installation" - description="discord, overview, telegram" - url="bot/installation" - /> -<ReferenceCard - title="Reference" - description="create, delete, list, update, add, list, remove, c15m, c3m, c5m, cc, cd, chart, chartfib, chartsr, cm, cw, bigprints, bio, compfees, fees, ir, prints, top, tvl, chart, table, allblocks, alldp, allprints, bigprints, levels, sectors, summary, topsum, arktrades, contracts, fgindex, halts, holidays, house, ipolist, senate, splits, trendingst, wsb, ah, analyst, bio, customer, divinfo, earnings, ermove, est, financials, insiders, instholdings, nexter, pm, pt, sec, splits, supplier, ytd, calendar, commodities, currencies, fedrates, glbonds, indices, revrepo, usbonds, yieldcurve, holdings, tops, bigflow, day, opening, prem, sectors, sumday, sumexp, summary, sumtop, sumweek, unu, weekly, 8ball, flip, urban, futures, heatchart, heatmap, markets, news, quote, ta, watchlist, contracts, house, senate, about, serverid, stats, support, chart, collection, top, chains, equitypc, gamma, highiv, hist, indexpc, info, itm, maxpain, oi, oichart, smile, stats, topoi, topoichange, topstrikevol, topvol, topvoletf, unu, uoastock, vol, vsurf, 1d, 1hr, ah, ah_all, all, pm, pm_all, technical, borrowed, hsi, shortrate, shortvol, topshortvol, c, c15m, c3m, c5m, cc, cd, chart, chartfib, chartsr, cm, cw, bigprints, bio, compfees, defi, fees, ir, prints, top, tvl, allblocks, alldp, allprints, bigprintsdp, levels, sectors, summary, topsum, arktrades, fgindex, halts, holidays, ipolist, pop, trendingst, wsb, ah, analyst, bio_stocks, customer, divinfo, earnings, ermove, financials, insiders, instholdings, nexter, pm, pt, sec, splits, supplier, ytd, bonds, calendar, commodities, currencies, fedrates, indices, revrepo, yieldcurve, holdings, tops, bigflow, sectorsflow, summaryflow, day, open, prem, unu, wk, day, exp, top, wk, 8ball, flip, urban, futures, news, quote, ta, contracts, house, senate, about, start, nftcollection, nfttop, chains, equitypc, gamma, highiv, hist, indexpc, itm, iv, maxpain, oi, oichart, opstats, smile, topoi, topoichange, topstrikevol, topvol, topvoletf, unu, uoastock, vol, vsurf, heatchart, heatmap, markets, watchlist, watchlist_add, watchlist_remove, screener, ah, all, pm, borrowed, hsi, shortrate, shortvol, topshortvol" - url="bot/reference" - /> -<ReferenceCard - title="Usage" - description="discord, telegram, individual, overview, server" - url="bot/usage" - /> -</ul> diff --git a/website/content/bot/installation/discord.md b/website/content/bot/installation/discord.md index 1e389dd673e..a4da8dfa579 100644 --- a/website/content/bot/installation/discord.md +++ b/website/content/bot/installation/discord.md @@ -1,5 +1,5 @@ --- -title: Setting up Discord bot +title: Discord bot sidebar_position: 2 description: This page guides you on how to add a bot to your Discord server, through steps of login, bot authorization, and adjusting bot permissions. diff --git a/website/content/bot/installation/overview.md b/website/content/bot/installation/index.md index 3ba49bea3c2..425b9e36b18 100644 --- a/website/content/bot/installation/overview.md +++ b/website/content/bot/installation/index.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Installation sidebar_position: 1 description: Learn how to use OpenBB Bot in Discord and Telegram. Understand the requirements for individual and server uses, and explore additional features by linking your diff --git a/website/content/bot/installation/index.mdx b/website/content/bot/installation/index.mdx deleted file mode 100644 index cfef3f07536..00000000000 --- a/website/content/bot/installation/index.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# installation - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6"> - -<ReferenceCard - title="Setting up Discord bot" - description="This page guides you on how to add a bot to your Discord server, through" - url="installation/Setting up Discord bot" -/> -<ReferenceCard - title="Overview" - description="Learn how to use OpenBB Bot in Discord and Telegram. Understand the requirements" - url="installation/Overview" -/> -<ReferenceCard - title="Setting up Telegram bot" - description="Step-by-step guide to add the OpenBB Bot to a Telegram group. From starting" - url="installation/Setting up Telegram bot" -/> -</ul> diff --git a/website/content/bot/installation/telegram.md b/website/content/bot/installation/telegram.md index 00e10176bac..6f17f836c8b 100644 --- a/website/content/bot/installation/telegram.md +++ b/website/content/bot/installation/telegram.md @@ -1,5 +1,5 @@ --- -title: Setting up Telegram bot +title: Telegram bot sidebar_position: 3 description: Step-by-step guide to add the OpenBB Bot to a Telegram group. From starting a chat with the bot to verifying its permissions, follow these steps to have your diff --git a/website/content/bot/usage/customizing/overview.md b/website/content/bot/usage/customizing/index.md index fc35dc706ab..5dfe2d97c87 100644 --- a/website/content/bot/usage/customizing/overview.md +++ b/website/content/bot/usage/customizing/index.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Customization sidebar_position: 1 description: A guide to OpenBB Bot settings customization, including chart themes, alerts, autoposting, and more. Learn how to link your account and start personalizing @@ -18,10 +18,9 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -<HeadTitle title="Overview - Customizing - Usage | OpenBB Bot Docs" /> +<HeadTitle title="Customizing - Usage | OpenBB Bot Docs" /> For the best user experience, you will want to customize the OpenBB Bot settings. Different types of customizations we offer are: - <div className="flex"> <ul> <li> diff --git a/website/content/bot/usage/customizing/index.mdx b/website/content/bot/usage/customizing/index.mdx deleted file mode 100644 index 0eb07dd9dd4..00000000000 --- a/website/content/bot/usage/customizing/index.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# customizing - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6"> - -<ReferenceCard - title="individual" - description="test" - url="/bot/reference/usage/customizing/individual" -/> -<ReferenceCard - title="overview" - description="te |