summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2023-11-24 15:01:55 -0800
committerGitHub <noreply@github.com>2023-11-24 15:01:55 -0800
commit44028ef3b53b3e454861548aa687d42df64bdd2f (patch)
treefc2cf18b8ec8bf587fc0ffe22ab480c6f1d640fd
parentc1ea5cc790efe1cdb840294d55eb1affbe88f184 (diff)
parentdd833ffbacd761b8fed1ce57c06b1873decb1707 (diff)
Merge branch 'develop' into docs/new-working-docs
-rw-r--r--website/content/pro/advanced-search.md4
-rw-r--r--website/content/pro/copilot.md5
-rw-r--r--website/content/pro/dashboards/folders.md4
-rw-r--r--website/content/pro/dashboards/grouping.md6
-rw-r--r--website/content/pro/dashboards/index.md15
-rw-r--r--website/content/pro/dashboards/report.md6
-rw-r--r--website/content/pro/dashboards/templates.md6
-rw-r--r--website/content/pro/getting-started/free-trial.md12
-rw-r--r--website/content/pro/getting-started/index.md4
-rw-r--r--website/content/pro/main-menu/charting.md9
-rw-r--r--website/content/pro/main-menu/data-connectors/index.md7
-rw-r--r--website/content/pro/main-menu/data-connectors/single-widget.md7
-rw-r--r--website/content/pro/main-menu/homepage.md4
-rw-r--r--website/content/pro/main-menu/index.md2
-rw-r--r--website/content/pro/main-menu/news.md20
-rw-r--r--website/content/pro/settings.md15
-rw-r--r--website/content/pro/widgets-library/economy/economic_calendar.md2
-rw-r--r--website/content/pro/widgets-library/economy/index.mdx13
-rw-r--r--website/content/pro/widgets-library/equity/analyst_estimates.md2
-rw-r--r--website/content/pro/widgets-library/equity/analyst_price_target.md2
-rw-r--r--website/content/pro/widgets-library/equity/analyst_upgrades_downgrades.md2
-rw-r--r--website/content/pro/widgets-library/equity/balance_sheet.md2
-rw-r--r--website/content/pro/widgets-library/equity/cash_flow_statement.md2
-rw-r--r--website/content/pro/widgets-library/equity/charting.md2
-rw-r--r--website/content/pro/widgets-library/equity/company_events.md2
-rw-r--r--website/content/pro/widgets-library/equity/company_news.md2
-rw-r--r--website/content/pro/widgets-library/equity/company_profile.md2
-rw-r--r--website/content/pro/widgets-library/equity/earnings_transcripts.md2
-rw-r--r--website/content/pro/widgets-library/equity/equity_select.md2
-rw-r--r--website/content/pro/widgets-library/equity/financial_ratios.md2
-rw-r--r--website/content/pro/widgets-library/equity/financial_statements.md2
-rw-r--r--website/content/pro/widgets-library/equity/global_news.md2
-rw-r--r--website/content/pro/widgets-library/equity/grouped_comparison.md2
-rw-r--r--website/content/pro/widgets-library/equity/income_statement.md2
-rw-r--r--website/content/pro/widgets-library/equity/index.mdx199
-rw-r--r--website/content/pro/widgets-library/equity/insider_trading.md2
-rw-r--r--website/content/pro/widgets-library/equity/institutional_ownership.md2
-rw-r--r--website/content/pro/widgets-library/equity/key_metrics.md2
-rw-r--r--website/content/pro/widgets-library/equity/management_team.md2
-rw-r--r--website/content/pro/widgets-library/equity/market_overview.md2
-rw-r--r--website/content/pro/widgets-library/equity/price_performance.md2
-rw-r--r--website/content/pro/widgets-library/equity/price_target.md2
-rw-r--r--website/content/pro/widgets-library/equity/revenue_per_bus_line.md2
-rw-r--r--website/content/pro/widgets-library/equity/revenue_per_geography.md2
-rw-r--r--website/content/pro/widgets-library/equity/sec_filings.md2
-rw-r--r--website/content/pro/widgets-library/equity/share_statistics.md2
-rw-r--r--website/content/pro/widgets-library/equity/stock_dividends.md2
-rw-r--r--website/content/pro/widgets-library/equity/stock_ownership.md2
-rw-r--r--website/content/pro/widgets-library/equity/stock_splits.md2
-rw-r--r--website/content/pro/widgets-library/equity/valuation_multiples.md2
-rw-r--r--website/content/pro/widgets-library/equity/watchlist.md2
-rw-r--r--website/content/pro/widgets-library/index.mdx27
-rw-r--r--website/content/pro/widgets-library/ui/index.mdx13
-rw-r--r--website/content/pro/widgets-library/utilities/clock.md22
-rw-r--r--website/content/pro/widgets-library/utilities/external_table.md22
-rw-r--r--website/content/pro/widgets-library/utilities/index.mdx13
-rw-r--r--website/content/pro/widgets-library/utilities/rich_note.md3
-rw-r--r--website/content/pro/widgets-library/utilities/rss_viewer.md22
-rw-r--r--website/content/pro/widgets/chat-with-widget.md5
-rw-r--r--website/content/pro/widgets/data-provider.md5
-rw-r--r--website/content/pro/widgets/index.md18
-rw-r--r--website/generate_platform_v4_markdown.py52
-rw-r--r--website/src/components/General/NewReferenceCard.tsx3
-rw-r--r--website/src/css/custom.css11
64 files changed, 433 insertions, 187 deletions
diff --git a/website/content/pro/advanced-search.md b/website/content/pro/advanced-search.md
index ad2ddeeebc9..5e259f780cc 100644
--- a/website/content/pro/advanced-search.md
+++ b/website/content/pro/advanced-search.md
@@ -23,13 +23,13 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
<TutorialVideo
- youtubeLink="https://www.youtube.com/embed/_O2MPRlr1-g?si=OUemTjczHFgxZheS"
+ youtubeLink="https://www.youtube.com/embed/42DS0EDFhwc?si=HU9XS86OhGy6X6ej"
videoLegend="Short introduction to Terminal Pro advanced search"
/>
OpenBB Terminal Pro's advanced search is a powerful tool that enables you to perform a wide range of tasks swiftly and efficiently.
-<img width="1455" alt="275681118-b5ed496a-5822-49c9-bc56-958dab886f59" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/b10a013f-ad07-4ea6-ac55-17236b249bb2"/>
+<img className="pro-border-gradient" width="800" alt="add widgets search" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/9758ac66-1a89-4c33-b54a-bf82c64ae07e" />
The search is divided into six main categories:
diff --git a/website/content/pro/copilot.md b/website/content/pro/copilot.md
index b8f7c5e238e..d46c99a5b1e 100644
--- a/website/content/pro/copilot.md
+++ b/website/content/pro/copilot.md
@@ -21,14 +21,13 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
<TutorialVideo
- youtubeLink="https://www.youtube.com/embed/HbKo74HwV-4?si=J6iqvjrPWcEH1I92"
+ youtubeLink="https://www.youtube.com/embed/oW_kwVBx4Eg?si=xGk1a9e5ZaQw8jCt"
videoLegend="Short introduction to Terminal Pro advanced search"
/>
OpenBB copilot is your companion to interact with the OpenBB Terminal Pro.
-![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/d7023765-7fcd-4bcb-bded-7ed44d4f7c18)
-
+<img className="pro-border-gradient" width="3701" alt="COPILOT- New" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/1c2d892e-03b7-4db8-9e8c-6fb1ab8512a1" />
To initiate a dialogue with the OpenBB Copilot, simply click on the icon located at the top left of your screen. You have the option to input your request either through typing or voice command.
diff --git a/website/content/pro/dashboards/folders.md b/website/content/pro/dashboards/folders.md
index 11ff73309f3..2c841cdd57a 100644
--- a/website/content/pro/dashboards/folders.md
+++ b/website/content/pro/dashboards/folders.md
@@ -21,12 +21,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
On the sidebar, users have a plus icon where they are able to create a new dashboard or folder.
-<img width="227" alt="275686370-ef2aadeb-3cc8-44ac-8680-dc6d8d776f79" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/ed469e45-6b36-42d0-bb19-8a1e92ce9c51"/>
+<img className="pro-border-gradient" width="2181" alt="add dash" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c8a88574-7ec4-4abd-8662-9e1f6cf376bc" />
This allows the creation of a new dashboard to perform investment research, or creating a folder to organize multiple dashboards.
Below is an example of a folder that contains multiple dashboards.
-<img width="225" alt="275686285-e3f429a3-e24e-4221-83d6-ed0a0cfdb831" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c8b542b5-0010-4efb-9169-f25b182f0135"/>
+<img className="pro-border-gradient" width="247" alt="folder" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/0c928803-7ef3-4b63-8313-5f5fec767197" />
A dashboard can be moved into a folder through the dashboard settings with the "Move to", or by dragging the dashboard into the folder.
diff --git a/website/content/pro/dashboards/grouping.md b/website/content/pro/dashboards/grouping.md
index 435d9f2fb0b..1030e7bb084 100644
--- a/website/content/pro/dashboards/grouping.md
+++ b/website/content/pro/dashboards/grouping.md
@@ -24,7 +24,7 @@ The grouping mechanism is extremely powerful as it allows widgets to be grouped
For instance, for the equity category, widgets can be connected through their ticker / symbol. Examples are: AAPL to simbolize Apple, TSLA for Tesla and so on.
-<img width="1250" alt="276163819-b4c80035-8ead-4fc9-b65b-c5b2c4b8e062" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/435b8fba-e0b7-4aa0-b92f-10d6b12589a2" />
+<img className="pro-border-gradient" width="800" alt="grouping" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/f0cbeb52-c7cd-4e03-9eba-5ef35e1665b6" />
This is an example of 3 widgets that belong to the same group, note the dark yellow 1 on the top right.
@@ -34,13 +34,11 @@ This means that if a user changes the ticker on any of these widgets, the remain
Also note that the grouping is visible on the sidebar, immediately under the dashboard naming.
-<img width="1438" alt="276164492-b773f4ec-6b7d-432a-8e2b-0beb55982857" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/2ccd3148-fec4-4c0b-af30-6f9f5661642c" />
-
### Watchlist and grouping
The watchlist widget has a special property in relation to grouping. Since this widget doesn't have a single symbol but many, users can select the row of their ticker of interest, and widgets that are grouped with the watchlist will get updated accordingly.
-<img width="1227" alt="276165201-9f52500e-5e83-44ba-b5ab-d19c2951a4ea" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/540a1b77-9712-4bfa-802e-f7d4d10c5895" />
+<img className="pro-border-gradient" width="800" alt="watchlist" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/d36380df-743a-4676-bec4-6bd34567e661" />
If a user selects a new ticker in another widget that is grouped with the watchlist, that ticker will be added to the watchlist and will become the one selected by default.
diff --git a/website/content/pro/dashboards/index.md b/website/content/pro/dashboards/index.md
index 5f014f28778..0bdebb18280 100644
--- a/website/content/pro/dashboards/index.md
+++ b/website/content/pro/dashboards/index.md
@@ -20,7 +20,14 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Dashboards | OpenBB Terminal Pro Docs" />
-<img width="1443" alt="275685305-db3b650a-5e33-4709-acc7-0f86f9522c06" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/e5f957db-3cf8-4873-9629-1fed0f08f2c7"/>
+import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
+
+<TutorialVideo
+ youtubeLink="https://www.youtube.com/embed/YSvPE_SM6Yo?si=VwltUN4AAWEZcLHi"
+ videoLegend="Short introduction to Terminal Pro dashboards"
+/>
+
+<img className="pro-border-gradient" width="800" alt="dash" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/156b080a-e32b-4d56-baf6-bb04038f2d63" />
Dashboards are a collection of widgets. In the image above you can see that there are 3 different dashboards and the one selected can be seen in the working area.
@@ -28,7 +35,7 @@ There are 2 ways to interact with dashboards.
### The plus icon at the bottom right
-<img width="357" alt="275685682-b4fd638e-2b4d-4216-96a6-31605a0c991a" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/5485e465-6685-462b-86ea-ad951fb0532b"/>
+<img className="pro-border-gradient" width="800" alt="add widget" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/e8a79a68-1712-4c9d-8a63-797aaa7fd541" />
This allows to:
@@ -39,7 +46,7 @@ This allows to:
### The settings icon on the Dashboard's sidebar
-<img width="380" alt="275685893-b48b8016-dfb0-48ac-9d85-2fefeb3facb1" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/a3ee6182-2010-45fc-bb67-3280df0e1e40"/>
+<img className="pro-border-gradient" width="800" alt="dash settings" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/13f536e7-dd5a-4f22-be1c-c65fd31eec6d" />
This allows to:
@@ -54,6 +61,6 @@ This allows to:
### The plus icon on the sidebar
-<img width="223" alt="275686811-6d7daa4d-6b09-4eb9-8972-626950fc7f6d" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/2bf5b35f-3522-4512-aac7-bc9bec178b00"/>
+<img className="pro-border-gradient" width="800" alt="add dash" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/5104df11-8cf4-4c80-b9ac-c6e831d28294" />
Which allows the creation of a new dashboard, or a new folder.
diff --git a/website/content/pro/dashboards/report.md b/website/content/pro/dashboards/report.md
index 025015d81a3..5fe6f77c0bf 100644
--- a/website/content/pro/dashboards/report.md
+++ b/website/content/pro/dashboards/report.md
@@ -19,12 +19,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Report | OpenBB Terminal Pro Docs" />
-<img width="1443" alt="275687043-c79f8643-3c34-43fd-bc77-a53384471e7b" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/9360faa9-1a46-43f9-8568-490ef5c1c5a1"/>
+<img className="pro-border-gradient" width="800" alt="Report export" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/1d1de065-469d-4f8d-b847-6ffc82cadf19" />
A report can be created out of a dashboard so that you have a static report of the interactive dashboard. This report can be a PDF or PNG format. This can be very powerful to record a moment in time, particularly when adding the text widget with additional insights from a user.
You can export a dashboard as a report through the bottom right plus icon on the working area or through the dashboard's settings on the sidebar.
-<img width="488" alt="275687512-66e63a3c-c662-4726-b514-195e5df4e1d4" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/1719ff82-ee3a-4b09-b355-2dbfe87d9876"/>
+<img className="pro-border-gradient" width="488" alt="dash settings" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/0cacf0bd-296b-45fa-954b-2d013f9f1694" />