diff --git a/website/config.toml b/website/config.toml
index 9e2d2008540..3a08c7acd25 100644
--- a/website/config.toml
+++ b/website/config.toml
@@ -1,5 +1,4 @@
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
-title = "OpenBB Documentation"
theme = "hugo-geekdoc"
# Required to get well formatted code blocks
@@ -24,7 +23,7 @@ enableGitInfo = true
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
# relative to your 'static/' folder.
- geekdocLogo = "openbb_logo.png"
+ geekdocLogo = "openbb_logo.svg"
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
geekdocMenuBundle = true
diff --git a/website/content/_index.md b/website/content/_index.md
index b64798090a4..f7373a0de96 100644
--- a/website/content/_index.md
+++ b/website/content/_index.md
@@ -1,18 +1,21 @@
---
-title: Getting Started
+title: OpenBB Terminal Documentation
keywords: "getting started, openbb, api, beginner guide, how to use openbb, openbb keys, openbb terminal, openbb, terminal"
excerpt: "This page guides you how to use the OpenBB terminal, developed by OpenBB."
description: "The OpenBB Documentation provides guidance on how to use the OpenBB Terminal, a free, custom built
financial terminal that will help you make more informed decisions, faster."
geekdocCollapseSection: true
---
+
## Introduction
OpenBB is a leading open source investment research software platform for accessing and analyzing financial market data.
We represent millions of investors who want to leverage state-of-the-art data science and machine learning technologies
to make sense of raw unrefined data. Our mission is to make investment research effective, powerful and accessible to everyone.
-**All our products are Free and Open-Source (FOSS).**
+---
+
+## The OpenBB Terminal is Free and Open-Source (FOSS)
@@ -25,11 +28,6 @@ to make sense of raw unrefined data. Our mission is to make investment research
----
-
If you are interested in the OpenBB Terminal,
-please continue reading this page and the related pages on each menu (e.g. Stocks
-or Economy)
-
---
{{< toc >}}
@@ -55,7 +53,6 @@ An open source product allows for higher quality, lower costs, more transparency
We believe that everyone should be able to have the same tooling to do investment research. By leveraging free API tiers, we can allow users to have access to a vast range of information for free. On the other hand, we want users that are willing to subscribe to premium API keys from certain data providers to be able to take advantage of that on OpenBB Terminal - this is where we see a monetization opportunity, a revenue share with data providers for connecting our users to their resources.
-
{{< /columns >}}
{{< columns >}}
@@ -157,7 +154,6 @@ If you have trouble launching the app because of security settings and the "Righ
-
## Structure of the OpenBB Terminal
The OpenBB Terminal is based off the Command Line Interface (CLI)
@@ -169,6 +165,7 @@ you are greeted with the following interface:
The OpenBB Terminal is centered around keyboard input. To navigate and perform analysis you will have to type in the name of the command followed by an `ENTER` (⏎). If you wish to see information about the OpenBB Terminal you can do so by typing `about` and then press `ENTER` (⏎). As you are typing, you will notice that you receive suggestions, by using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select the command and execute it.
Throughout the entire terminal, the same set of colors are used which all share the same representation. This is structured as follows:
+
- Light Blue: represents commands.
- Dark Blue: represents menus, also recognizable by the `>` in front.
- Orange: represents titles and headers.
@@ -188,11 +185,13 @@ and menus you can select. There are interactions in place between each menu. For
the `stocks` menu, the terminal will remember your selection when you visit the `fa` or `options` menu.
See Introduction to Stocks for more information.
-___
+---
+
**Pro tip:** you can quickly jump between menus by using a forward slash (`/`). For example, if I want to access the options
menu, I can type `/stocks/options` to instantly arrive at this menu. You can do this from any location within the
OpenBB Terminal!
-___
+
+---
### Explanation of Commands
@@ -202,10 +201,10 @@ the commands that you are able to use from any menu in the terminal (see this guide.
+ command. For example, within the `stocks` menu, `about candle` opens this guide.
Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you
will see a command named load. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following:
@@ -299,14 +298,15 @@ selected period.
```
2022 May 19, 05:44 (🦋) /stocks/ $ candle
```
+
As mentioned in the Explanation of Menus, some information also transfers over to other menus and this includes the
loaded market data from load.
So, if you would visit the `ta` menu (which stands for Technical Analysis) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.
-
### Explanation of Scripts
+
The `.openbb` scripts offer the ability to automatically run a set of commands in the form of a **routine**. Furthermore,
the scripts can be adapted, and documented, at any moment giving the user full control over the type of analysis you wish
to do (and repeat). This can fundamental research, understanding market movements, finding hidden gems and even
@@ -327,7 +327,7 @@ Within this menu you are able to set your API keys to access the commands that r
To figure out where you can obtain the API key, you can enter the command (e.g. `av`) and press `ENTER` (⏎) or use the table below. **We recommend that you gradually obtain and set keys whenever you wish to use features that require an API key. For example, if you are interested in viewing recent news about a company, you should set the API key from the 'News API'.**
| Command | Name | URL |
-|:-----------|:-----------------------------------------|:-----------------------------------------------------------------------------------|
+| :--------- | :--------------------------------------- | :--------------------------------------------------------------------------------- |
| av | AlphaVantage | https://www.alphavantage.co/support/#api-key |
| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ |
| quandl | Quandl | https://www.quandl.com |
@@ -364,34 +364,36 @@ There is a large collection of (sub) menus available. Here, the asset class and
The asset class menus are as follows:
- Introduction to Stocks: access historical pricing data, options, sector and
-industry analysis, and overall due diligence.
+ industry analysis, and overall due diligence.
- Introduction to Crypto: dive into onchain data, tokenomics, circulation supply,
-nfts and more.
+ nfts and more.
- Introduction to ETF: explore exchange traded funds, historical pricing, holdings
-and screeners.
+ and screeners.
- Introduction to Forex: see foreign exchanges, quotes, forward rates for currency
-pairs and Oanda integration.
+ pairs and Oanda integration.
- Introduction to Funds: discover mutual funds, general overviews, holdings and
-sector weights.
+ sector weights.
The other menus are as follows:
- Introduction to Economy: explore global macroeconomic data including
-interest and inflation rates, GDP and its components, futures, yield curves and treasury rates.
+ interest and inflation rates, GDP and its components, futures, yield curves and treasury rates.
- Introduction to Alternative: explore alternative datasets such as COVID and
-open source metrics.
+ open source metrics.
- Introduction to Econometrics: perform (advanced) regression techniques and
-statistical tests on custom datasets to understand relationships for both time series and panel data.
+ statistical tests on custom datasets to understand relationships for both time series and panel data.
- Introduction to Portfolio: understand how your portfolio evolved over time, what
-assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio
-optimization techniques.
+ assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio
+ optimization techniques.
- Introduction to Dashboards: see interactive dashboards using voila and
-jupyter notebooks.
+ jupyter notebooks.
- Introduction to Reports (Work in Progress): create customizable research reports through jupyter notebooks.
## Customizing the terminal
+
To adjust the lay-out and settings of the OpenBB Terminal you can access the `settings` menu. This menu allows you to
tweak how the terminal behaves. This includes the following:
+
- `dt` adds or removes the datetime from the flair (which is next to the emoji).
- `flair` allows you to change the emoji that is used.
- `lang` gives the ability to change the terminal language. At this moment, the terminal is only available in English.
@@ -409,6 +411,7 @@ tweak how the terminal behaves. This includes the following:
Next to that, to enable or disable certain functionalities of the terminal you can use the `featflags` menu which
includes the following:
+
- `logcollection` whether you wish to enable logging to help the OpenBB team improve functionalities (default is yes).
- `retryload` whenever you misspell commands, try to use the `load` command with it first (default is no).
- `tab` whether to use tabulate to print DataFrames, to prettify these DataFrames (default is yes).
diff --git a/website/data/menu/more.yml b/website/data/menu/more.yml
index 5a95a635140..96162f8a572 100644
--- a/website/data/menu/more.yml
+++ b/website/data/menu/more.yml
@@ -1,11 +1,15 @@
---
more:
+ - name: "Go to main website"
+ ref: "https://openbb.co"
+ external: true
+ icon: "gdoc_link"
- name: "Install the Terminal"
- ref: "https://www.openbb.co/products/terminal"
+ ref: "https://openbb.co/products/terminal"
external: true
icon: "gdoc_download"
- name: "Fill in the Survey"
- ref: "https://www.openbb.co/survey"
+ ref: "https://openbb.co/survey"
external: true
icon: "gdoc_bookmark"
- name: "View Source"
diff --git a/website/public/index.html b/website/public/index.html
index d3f60338764..bdbe54cff99 100644
--- a/website/public/index.html
+++ b/website/public/index.html
@@ -1,813 +1,713 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
OpenBB Terminal
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 
- 
-