summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandrewkenreich <andrew.kenreich@gmail.com>2023-11-13 17:04:23 -0500
committerandrewkenreich <andrew.kenreich@gmail.com>2023-11-13 17:04:23 -0500
commit345c72b864749e54e5410a8ea8b3d77da983d69b (patch)
tree9fdf5106504fca2b56a39c539c2540b429cbd114
parent8b95d19b432b39ef9a297c9f48c653d8866210a8 (diff)
cool cards
-rw-r--r--website/content/bot/changelog/index.mdx57
-rw-r--r--website/content/bot/index.mdx27
-rw-r--r--website/content/bot/installation/index.mdx22
-rw-r--r--website/content/bot/reference/discord/alerts/index.mdx27
-rw-r--r--website/content/bot/reference/discord/charts/index.mdx57
-rw-r--r--website/content/bot/reference/discord/crypto/index.mdx52
-rw-r--r--website/content/bot/reference/discord/darkpool/index.mdx47
-rw-r--r--website/content/bot/reference/discord/discovery/index.mdx62
-rw-r--r--website/content/bot/reference/discord/duedilligence/index.mdx97
-rw-r--r--website/content/bot/reference/discord/economy/index.mdx52
-rw-r--r--website/content/bot/reference/discord/etf/index.mdx17
-rw-r--r--website/content/bot/reference/discord/flow/index.mdx67
-rw-r--r--website/content/bot/reference/discord/fun/index.mdx22
-rw-r--r--website/content/bot/reference/discord/general/index.mdx47
-rw-r--r--website/content/bot/reference/discord/government/index.mdx22
-rw-r--r--website/content/bot/reference/discord/index.mdx102
-rw-r--r--website/content/bot/reference/discord/info/index.mdx27
-rw-r--r--website/content/bot/reference/discord/nft/index.mdx22
-rw-r--r--website/content/bot/reference/discord/options/index.mdx117
-rw-r--r--website/content/bot/reference/discord/pop/index.mdx17
-rw-r--r--website/content/bot/reference/discord/screeners/index.mdx37
-rw-r--r--website/content/bot/reference/discord/short_data/index.mdx32
-rw-r--r--website/content/bot/reference/telegram/charts/index.mdx62
-rw-r--r--website/content/bot/reference/telegram/crypto/index.mdx52
-rw-r--r--website/content/bot/reference/telegram/darkpool/index.mdx47
-rw-r--r--website/content/bot/reference/telegram/discovery/index.mdx47
-rw-r--r--website/content/bot/reference/telegram/duediligence/index.mdx92
-rw-r--r--website/content/bot/reference/telegram/economy/index.mdx47
-rw-r--r--website/content/bot/reference/telegram/etf/index.mdx17
-rw-r--r--website/content/bot/reference/telegram/flow/index.mdx32
-rw-r--r--website/content/bot/reference/telegram/fun/index.mdx22
-rw-r--r--website/content/bot/reference/telegram/general/index.mdx27
-rw-r--r--website/content/bot/reference/telegram/government/index.mdx22
-rw-r--r--website/content/bot/reference/telegram/index.mdx92
-rw-r--r--website/content/bot/reference/telegram/info/index.mdx17
-rw-r--r--website/content/bot/reference/telegram/nft/index.mdx17
-rw-r--r--website/content/bot/reference/telegram/options/index.mdx117
-rw-r--r--website/content/bot/reference/telegram/screeners/index.mdx17
-rw-r--r--website/content/bot/reference/telegram/short_data/index.mdx32
-rw-r--r--website/content/bot/usage/customizing/index.mdx22
-rw-r--r--website/content/bot/usage/index.mdx22
-rw-r--r--website/content/generate_index.py102
-rw-r--r--website/content/platform/contributing/index.mdx32
-rw-r--r--website/content/platform/data_models/index.mdx839
-rw-r--r--website/content/platform/index.mdx32
-rw-r--r--website/content/platform/usage/index.mdx27
-rw-r--r--website/content/sdk/data-available/index.mdx72
-rw-r--r--website/content/sdk/faqs/index.mdx37
-rw-r--r--website/content/sdk/reference/index.mdx82
-rw-r--r--website/content/sdk/usage/index.mdx17
-rw-r--r--website/content/terminal/changelog/index.mdx92
-rw-r--r--website/content/terminal/changelog/version2_5_1.mdx2
-rw-r--r--website/content/terminal/faqs/index.mdx37
-rw-r--r--website/content/terminal/index.mdx37
-rw-r--r--website/content/terminal/installation/index.mdx32
-rw-r--r--website/content/terminal/menus/common/index.mdx22
-rw-r--r--website/content/terminal/menus/crypto/index.mdx42
-rw-r--r--website/content/terminal/menus/index.mdx22
-rw-r--r--website/content/terminal/menus/stocks/index.mdx62
-rw-r--r--website/content/terminal/reference/crypto/index.mdx82
-rw-r--r--website/content/terminal/reference/econometrics/index.mdx122
-rw-r--r--website/content/terminal/reference/economy/index.mdx97
-rw-r--r--website/content/terminal/reference/etf/index.mdx67
-rw-r--r--website/content/terminal/reference/forecast/index.mdx197
-rw-r--r--website/content/terminal/reference/forex/index.mdx42
-rw-r--r--website/content/terminal/reference/funds/index.mdx57
-rw-r--r--website/content/terminal/reference/futures/index.mdx22
-rw-r--r--website/content/terminal/reference/portfolio/index.mdx127
-rw-r--r--website/content/terminal/reference/reports/index.mdx12
-rw-r--r--website/content/terminal/reference/stocks/index.mdx112
-rw-r--r--website/content/terminal/usage/data/index.mdx22
-rw-r--r--website/content/terminal/usage/index.mdx27
-rw-r--r--website/content/terminal/usage/outputs/index.mdx22
-rw-r--r--website/content/terminal/usage/overview/index.mdx22
-rw-r--r--website/content/terminal/usage/routines/index.mdx37
-rw-r--r--website/src/theme/DocSidebarItem/Category/index.js32
76 files changed, 4015 insertions, 504 deletions
diff --git a/website/content/bot/changelog/index.mdx b/website/content/bot/changelog/index.mdx
new file mode 100644
index 00000000000..09d847c91c8
--- /dev/null
+++ b/website/content/bot/changelog/index.mdx
@@ -0,0 +1,57 @@
+# changelog
+
+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="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"
+/>
+<ReferenceCard
+ title="v1.0.2"
+ description="v1.0.2"
+ url="changelog/v1.0.2"
+/>
+<ReferenceCard
+ title="v1.0.3"
+ description="v1.0.3"
+ url="changelog/v1.0.3"
+/>
+<ReferenceCard
+ title="v1.0.4"
+ description="v1.0.4"
+ url="changelog/v1.0.4"
+/>
+<ReferenceCard
+ title="v1.0.5"
+ description="v1.0.5"
+ url="changelog/v1.0.5"
+/>
+<ReferenceCard
+ title="v1.0.6"
+ description="v1.0.6"
+ url="changelog/v1.0.6"
+/>
+<ReferenceCard
+ title="v1.0.7"
+ description="v1.0.7"
+ url="changelog/v1.0.7"
+/>
+<ReferenceCard
+ title="v1.0.8"
+ description="v1.0.8"
+ url="changelog/v1.0.8"
+/>
+<ReferenceCard
+ title="Current - v2.0.0"
+ description="v2.0.0"
+ url="changelog/Current - v2.0.0"
+/>
+</ul>
diff --git a/website/content/bot/index.mdx b/website/content/bot/index.mdx
new file mode 100644
index 00000000000..08dce815d0f
--- /dev/null
+++ b/website/content/bot/index.mdx
@@ -0,0 +1,27 @@
+# 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/index.mdx b/website/content/bot/installation/index.mdx
new file mode 100644
index 00000000000..cfef3f07536
--- /dev/null
+++ b/website/content/bot/installation/index.mdx
@@ -0,0 +1,22 @@
+# 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/reference/discord/alerts/index.mdx b/website/content/bot/reference/discord/alerts/index.mdx
new file mode 100644
index 00000000000..022b3069ac9
--- /dev/null
+++ b/website/content/bot/reference/discord/alerts/index.mdx
@@ -0,0 +1,27 @@
+# alerts
+
+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="create"
+ 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="This command allows the user to delete an active alert they have set."
+ url="/bot/reference/discord/alerts/delete"
+/>
+<ReferenceCard
+ title="list"
+ 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