From 326f239d0142a250a31128f148d7b8802c395298 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Mon, 15 Apr 2024 14:49:55 -0700 Subject: [PATCH] Add single widgets public endpoints examples (#6312) * Add single widgets public endpoints examples * add couple more examples * imrpove documentation * update with video --- website/content/pro/advanced-search.md | 2 +- .../index.md => architecture.md} | 6 +-- website/content/pro/copilot/index.md | 6 +-- .../content/pro/dashboards/_category_.json | 4 +- .../pro/data-connectors/_category_.json | 2 +- .../data-connectors/single-widget/examples.md | 23 +++++++++ .../index.md} | 2 +- .../pro/getting-started/_category_.json | 4 -- .../content/pro/getting-started/free-trial.md | 41 ---------------- website/content/pro/index.md | 49 ++----------------- website/content/pro/templates/_category_.json | 4 ++ website/content/pro/templates/excel.md | 28 +++++++++++ website/content/pro/templates/index.md | 34 +++++++++++++ website/content/pro/templates/pro.md | 18 +++++++ website/content/pro/tutorials/_category_.json | 2 +- website/content/pro/tutorials/index.md | 2 +- website/content/pro/widgets/_category_.json | 2 +- 17 files changed, 126 insertions(+), 103 deletions(-) rename website/content/pro/{getting-started/index.md => architecture.md} (96%) create mode 100644 website/content/pro/data-connectors/single-widget/examples.md rename website/content/pro/data-connectors/{single-widget.md => single-widget/index.md} (98%) delete mode 100644 website/content/pro/getting-started/_category_.json delete mode 100644 website/content/pro/getting-started/free-trial.md create mode 100644 website/content/pro/templates/_category_.json create mode 100644 website/content/pro/templates/excel.md create mode 100644 website/content/pro/templates/index.md create mode 100644 website/content/pro/templates/pro.md diff --git a/website/content/pro/advanced-search.md b/website/content/pro/advanced-search.md index e6443dda2a2d..653c5d03d512 100644 --- a/website/content/pro/advanced-search.md +++ b/website/content/pro/advanced-search.md @@ -1,6 +1,6 @@ --- title: Advanced Search -sidebar_position: 6 +sidebar_position: 7 description: Learn about the functionality of the advanced search in OpenBB Terminal Pro. Discover the six main categories including Securities, Templates, Widgets, Actions, News, and the All option that enhances research and productivity. diff --git a/website/content/pro/getting-started/index.md b/website/content/pro/architecture.md similarity index 96% rename from website/content/pro/getting-started/index.md rename to website/content/pro/architecture.md index 0ad429003d51..660c70b9fff1 100644 --- a/website/content/pro/getting-started/index.md +++ b/website/content/pro/architecture.md @@ -1,6 +1,6 @@ --- -title: Getting Started -sidebar_position: 0 +title: Architecture +sidebar_position: 1 description: Get started with OpenBB Terminal Pro, your comprehensive tool for investment research. Understand the layout and powerful features that can enhance your research capabilities. @@ -19,7 +19,7 @@ keywords: import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + Welcome to the OpenBB Terminal Pro, your comprehensive tool for investment research. diff --git a/website/content/pro/copilot/index.md b/website/content/pro/copilot/index.md index 5d21786e7793..e8b34344e7fc 100644 --- a/website/content/pro/copilot/index.md +++ b/website/content/pro/copilot/index.md @@ -1,6 +1,6 @@ --- title: OpenBB Copilot -sidebar_position: 7 +sidebar_position: 8 description: Learn how to use OpenBB Copilot to interact with the OpenBB Terminal Pro keywords: - OpenBB Copilot @@ -108,7 +108,7 @@ Sometimes you may wish to focus your analysis and utilize OpenBB Copilot to anal a specific subset of widgets. For example, you may want to use OpenBB Copilot is assist you in a deep analysis of an earnings transcript in the "Earnings Transcript" widget, without retrieving data from the rest of the dashboard. - + To achieve this, you can chat with specifically selected widgets by clicking on the "Add widgets as context" button on each widget you wish to use while querying OpenBB Copilot. Selecting a widget in this manner will make that @@ -139,4 +139,4 @@ filenames that are descriptive of the data that they contain. For example, given a PDF file containing a technical report from TSLA released in 2024, a good filename would be `tsla_technical_report_2024.pdf`. -::: +::: diff --git a/website/content/pro/dashboards/_category_.json b/website/content/pro/dashboards/_category_.json index c805f86dfa3a..ff5b5ec938fb 100644 --- a/website/content/pro/dashboards/_category_.json +++ b/website/content/pro/dashboards/_category_.json @@ -1,4 +1,4 @@ { "label": "Dashboards", - "position": 5 -} \ No newline at end of file + "position": 6 +} diff --git a/website/content/pro/data-connectors/_category_.json b/website/content/pro/data-connectors/_category_.json index 50f9cdcbc833..4462097d884e 100644 --- a/website/content/pro/data-connectors/_category_.json +++ b/website/content/pro/data-connectors/_category_.json @@ -1,4 +1,4 @@ { "label": "Data Connectors", - "position": 3 + "position": 4 } diff --git a/website/content/pro/data-connectors/single-widget/examples.md b/website/content/pro/data-connectors/single-widget/examples.md new file mode 100644 index 000000000000..bc4ddbebfefe --- /dev/null +++ b/website/content/pro/data-connectors/single-widget/examples.md @@ -0,0 +1,23 @@ +--- +title: Endpoint Examples +sidebar_position: 1 +description: Public API endpoints that can be used as single widget for Terminal Pro +keywords: +- Single Widget +- Data Connectors +- API Endpoints +- JSON +- Bring your own data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +| Widget title | Public URL | Category | Subcategory | Source | Description | +| -------- | ------- | -------- | ------- | -------- | ------- | +| Protocols | https://api.llama.fi/v2/protocols | DeFi | TVL | DefiLLama | List of all protocols on DefiLlama along with their TVL | +| Historical Chain TVL | https://api.llama.fi/v2/historicalChainTvl | DeFi | TVL | DefiLLama | Get historical TVL (excludes liquid staking and double counted tvl) on DeFi on all chains | +| Chains | https://api.llama.fi/v2/chains | DeFi | TVL | DefiLLama | Get current TVL of all chains | +| Stablecoins | https://api.llama.fi/v2/stablecoins | DeFi | coins | DefiLLama | List all stablecoins along with their circulating amounts | +| TAO stats | https://taostats.io/data.json | Crypto | | Tao | Latest $TAO token and subnet information | diff --git a/website/content/pro/data-connectors/single-widget.md b/website/content/pro/data-connectors/single-widget/index.md similarity index 98% rename from website/content/pro/data-connectors/single-widget.md rename to website/content/pro/data-connectors/single-widget/index.md index 815c1029b81a..75bf0e6fd843 100644 --- a/website/content/pro/data-connectors/single-widget.md +++ b/website/content/pro/data-connectors/single-widget/index.md @@ -1,6 +1,6 @@ --- title: Single widget -sidebar_position: 1 +sidebar_position: 0 description: Learn how to use the Single Widget of OpenBB Terminal Pro for seamless integration with your API Endpoints, enabling custom data to be fetched and displayed in an accessible format. Includes features like additional headers and addressing diff --git a/website/content/pro/getting-started/_category_.json b/website/content/pro/getting-started/_category_.json deleted file mode 100644 index 446d1af1efe5..000000000000 --- a/website/content/pro/getting-started/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Getting started", - "position": 0 -} diff --git a/website/content/pro/getting-started/free-trial.md b/website/content/pro/getting-started/free-trial.md deleted file mode 100644 index e2d7a2bb845e..000000000000 --- a/website/content/pro/getting-started/free-trial.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Free trial -sidebar_position: 1 -description: The free trial of OpenBB Terminal Pro provides full access to its features - for 2 weeks with a potential 1-week extension. Steps to get early access and personalized - onboarding process are also explained. -keywords: -- Free Trial -- OpenBB Hub account -- early access code -- product development -- free trial extension -- Personalized Onboarding -- investment interests ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -There are 3 main ways to get started: - -1. Join the waitlist at - -2. Get invited by a colleague who already has access - -3. Become a design partner and contribute to our product development - -The free trial of **OpenBB Terminal Pro** grants you full access to all features and data for a period of 2 weeks. - -To continue using the product after the trial period you can reach out to to extend your trial and discuss pricing options. - -As an early adopter, your feedback is invaluable. The OpenBB team may reach out to understand your experience and gather insights for improvement. - -## Personalized Onboarding - -Upon your first login, we'll ask a few questions about your investment interests, background, and workflow. - -Your responses will help us tailor your experience, ensuring a smooth and effective start with the app. - -Note: You can update these responses anytime should your interests evolve. diff --git a/website/content/pro/index.md b/website/content/pro/index.md index ffb7947bd2f6..67334e876ac5 100644 --- a/website/content/pro/index.md +++ b/website/content/pro/index.md @@ -25,66 +25,27 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -Discover the superior investment research capabilities of the OpenBB Terminal Pro. Built on top of the open-source OpenBB Terminal, our platform provides a sleek graphical interface that is intuitive and fully customizable, making it easier for you to access and analyze financial information with ease. +Investment research tech is stuck in the 80s and limits what you can do. With the Terminal Pro, you can bring your own data and use AI to quickly extract insights from it. -Plus, with built-in access to high-quality financial data curated from official partnerships with data providers, you can conduct comprehensive analysis and gain valuable insights that inform your investment decisions. +Gain an edge in the market, start the 3-week free trial now. No credit cards required.
- - ---- - -- **Improved User Experience** - -We've focused on improving the user experience (UX) of the OpenBB Terminal Pro based on feedback from dozens of users. The platform features a better user interface that is visually appealing, while keeping the keyboard-centric workflow of the OpenBB Terminal for quick and efficient information access. - -- **Customizable and Collaborative** - -Unlike traditional investment research dashboards, the OpenBB Terminal Pro is a fully integrated and customizable environment that allows you to optimize your workflow to your preferences. Plus, take advantage of advanced collaboration features to share insights, exchange ideas, and make informed decisions with your team in real time. - -- **Built-in access to high-quality financial data** - -The OpenBB Terminal Pro is powered by an extensive data marketplace that allows you to make use of any dataset that exists. With an abundance of data at your fingertips, you can conduct a comprehensive analysis and gain valuable insights that inform your investment decisions. You can subscribe to only the datasets you need and access the raw data for deeper analysis, whether you're looking for financial, economic, or market data. - ---- - -## Features - -### Bring your own data - -The OpenBB Terminal Pro allows professionals to bring any data into their research environment. Whether that is a .csv file, a private endpoint, a RSS feed or even embed a SEC filing directly. The only limit is the user's creativity. - -### Your terminal, your whiteboard - -The OpenBB Terminal Pro is the most flexible investment research platform. It allows users to create their preferred dashboards with their preferred widgets. Never be limited again by what a platform allows you to create. - -### Generative AI to summarize content - -Our most popular feature includes chatting with financial data through state-of-the-art large language models (LLMs). For instance, instead of spending minutes reading news articles or hours reading earnings transcripts, create a summary in seconds and ask how that impacts your investments. - -### Build investment research reports in seconds - -The OpenBB Terminal Pro allows to add notes next to each widget and render the tab into a custom report that can be used to share with the team or manager., share with team - -### Create charts from raw data - -The OpenBB Terminal Pro allows to create charts directly from raw data in seconds. This effectively increases user efficiency by 10x, as visual insights are much more powerful. diff --git a/website/content/pro/templates/_category_.json b/website/content/pro/templates/_category_.json new file mode 100644 index 000000000000..a74b76d66039 --- /dev/null +++ b/website/content/pro/templates/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Templates", + "position": 3 +} diff --git a/website/content/pro/templates/excel.md b/website/content/pro/templates/excel.md new file mode 100644 index 000000000000..2a2ada7a97fe --- /dev/null +++ b/website/content/pro/templates/excel.md @@ -0,0 +1,28 @@ +--- +title: Excel Templates +sidebar_position: 2 +description: Download Excel templates that OpenBB makes available + to your organization so you can fully automate your workflow. +keywords: +- Excel Add-In +- Automation +- Workflow +- Download +- Modeling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +When navigating to the Templates page and clicking on the Excel tab, this is what the user will be able to see. As you can see from the image below, the user will be able to see a list of Excel templates that have been created by the OpenBB team and that leverage our Add-in for Excel to automate financial workflows. + +charting + +Once clicking on "Download Template" (e.g. for "Equity Analysis"), users will be able to access an Excel spreadsheet like the one shown below. + +If you have your OpenBB Add-in for Excel installed (instructions [here](/excel/getting-started/installation)) you will be able to change a ticker on the spreadsheet and all the values are automatically updated. + +charting + +More templates will be added in the next few weeks. diff --git a/website/content/pro/templates/index.md b/website/content/pro/templates/index.md new file mode 100644 index 000000000000..a959b3dfbc77 --- /dev/null +++ b/website/content/pro/templates/index.md @@ -0,0 +1,34 @@ +--- +title: Templates +sidebar_position: 0 +description: This page allows users to manage their Terminal Pro and Excel templates. +keywords: +- Templates +- Terminal Pro +- Excel Add-in +- Automated +- Download +--- + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; + +
    + + + + + +
diff --git a/website/content/pro/templates/pro.md b/website/content/pro/templates/pro.md new file mode 100644 index 000000000000..8dfc6a9222d5 --- /dev/null +++ b/website/content/pro/templates/pro.md @@ -0,0 +1,18 @@ +--- +title: Terminal Pro Templates +sidebar_position: 1 +description: Manage your organization's Terminal Pro templates + from this page. +keywords: +- Terminal Pro +- Templates +- Dashboard +- Widgets +- Sharing +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Coming soon. diff --git a/website/content/pro/tutorials/_category_.json b/website/content/pro/tutorials/_category_.json index 14856fcd7cec..d7a53ea59831 100644 --- a/website/content/pro/tutorials/_category_.json +++ b/website/content/pro/tutorials/_category_.json @@ -1,4 +1,4 @@ { "label": "Tutorials", - "position": 10 + "position": 0 } diff --git a/website/content/pro/tutorials/index.md b/website/content/pro/tutorials/index.md index 1852df2270bf..c19173707ae4 100644 --- a/website/content/pro/tutorials/index.md +++ b/website/content/pro/tutorials/index.md @@ -1,6 +1,6 @@ --- title: Tutorials -sidebar_position: 0 +sidebar_position: -1 description: Learn about common workflows that you can do with the OpenBB Terminal Pro. keywords: - workflows diff --git a/website/content/pro/widgets/_category_.json b/website/content/pro/widgets/_category_.json index e76371f2e074..5bca832ff794 100644 --- a/website/content/pro/widgets/_category_.json +++ b/website/content/pro/widgets/_category_.json @@ -1,4 +1,4 @@ { "label": "Widgets", - "position": 4 + "position": 5 }