Improvements within the Terminal for the Documentation

[JerBouma]

This PR features a bunch of things:

• Home menu is now much smaller. The examples only confuses users that have no idea how to make the terminal work in the first place. Also, commands that are accessible from anywhere don't have to be mentioned both in the menu as well as the bottom bar.
• The about command now directs to the documentation and is dynamic. If you open the stocks page it will direct to that page. It also allows you to enter a command or menu that is on the page. E.g. from stocks you can type about th to go to the Trading Hours documentation.
• Make sure that every link with about actually works. This requires URL changes on the website. This now aligns with the commands that are visible within the terminal. This should have been a 1-to-1 relationship in the first place.
• Make adjustments when the user tries to access a common menu via about
• Change the update command so users who are using the packaged version do not get some weird error.
• Update the Getting Started documentation with more info on optional arguments, fix a link and add some more info about navigation in the terminal.
• Update the keys menu to work well with about and update the text attached to it. It should now be clear that by typing about you get send to https://openbb-finance.github.io/OpenBBTerminal/#accessing-other-sources-of-data-via-api-keys

[JerBouma]

One thing we have to check is whether about works every time. We will notice that once the website updates too.

[DidierRLopes]

My first thought is can we leave update for people who aren't using the installer?

[JerBouma]

My first thought is can we leave update for people who aren't using the installer?

We saw people frequently messing this up that did have the installer. Is this really something people are using actively? To me, especially if you went through the whole installation process, it is just as easily done with git pull (since you have done that anyways).

[DidierRLopes]

My first thought is can we leave update for people who aren't using the installer?

We saw people frequently messing this up that did have the installer. Is this really something people are using actively? To me, especially if you went through the whole installation process, it is just as easily done with git pull (since you have done that anyways).

That's why I was saying for people who are not using the installer.

If you check the logs and update is not being successfully used either (from people who are using python) then I think we should drop it. But let's make sure is not being used first.

[JerBouma]

My first thought is can we leave update for people who aren't using the installer?

We saw people frequently messing this up that did have the installer. Is this really something people are using actively? To me, especially if you went through the whole installation process, it is just as easily done with git pull (since you have done that anyways).

That's why I was saying for people who are not using the installer.

If you check the logs and update is not being successfully used either (from people who are using python) then I think we should drop it. But let's make sure is not being used first.

Oh yeah that's fine but is it relatively easy to disable it for people using the installer?

[DidierRLopes]

My first thought is can we leave update for people who aren't using the installer?

We saw people frequently messing this up that did have the installer. Is this really something people are using actively? To me, especially if you went through the whole installation process, it is just as easily done with git pull (since you have done that anyways).

That's why I was saying for people who are not using the installer.
If you check the logs and update is not being successfully used either (from people who are using python) then I think we should drop it. But let's make sure is not being used first.

Oh yeah that's fine but is it relatively easy to disable it for people using the installer?

@piiq mentioned that there is a flag for it.

[piiq]

We can print the download link to ppl who are using the installer when they call the update command. Will that work? @JerBouma @DidierRLopes

[JerBouma]

That sounds fine, what's the flag for it? Then I can add it back in. @piiq @DidierRLopes

[JerBouma]

Ok fixed, care to review @DidierRLopes?

This is with PACKAGED_APPLICATION set to True.

(gst) jeroenbouma@MacBook-Pro-van-Jeroen OpenBB Terminal % python terminal.py

Welcome to OpenBB Terminal v1.5.0

╭──────────────────────────────────────────────────────────────────────────────────────── Home ────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                                                                                                                      │
│ Information, guides and support for the OpenBB Terminal                                                                                                                              │
│     about              discover the capabilities of the OpenBB Terminal (https://openbb.co/docs)                                                                                     │
│     support            pre-populate a support ticket for our team to evaluate                                                                                                        │
│     update             attempt to update the terminal automatically (GitHub version)                                                                                                 │
│                                                                                                                                                                                      │
│ Configure your own terminal:                                                                                                                                                         │
│ >   keys               set API keys and check their validity                                                                                                                         │
│ >   featflags          enable and disable feature flags                                                                                                                              │
│ >   settings           tune settings (export folder, timezone, language, plot size)                                                                                                  │
│                                                                                                                                                                                      │
│     exe                execute automated routine script                                                                                                                              │
│                                                                                                                                                                                      │
│ Main menu:                                                                                                                                                                           │
│ >   stocks             access historical pricing data, options, sector and industry, and overall due diligence                                                                       │
│ >   crypto             dive into onchain data, tokenomics, circulation supply, nfts and more                                                                                         │
│ >   etf                exchange traded funds. Historical pricing, compare holdings and screening                                                                                     │
│ >   economy            global macroeconomic data, e.g. futures, yield, treasury                                                                                                      │
│ >   forex              foreign exchanges, quotes, forward rates for currency pairs and oanda integration                                                                             │
│ >   funds              mutual funds search, overview, holdings and sector weights                                                                                                    │
│ >   alternative        alternative datasets, such as COVID and open source metrics                                                                                                   │
│                                                                                                                                                                                      │
│ Others:                                                                                                                                                                              │
│ >   econometrics       statistical and quantitative methods for relationships between datasets                                                                                       │
│ >   portfolio          perform portfolio optimization and look at portfolio performance and attribution                                                                              │
│ >   dashboards         interactive dashboards using voila and jupyter notebooks                                                                                                      │
│ >   reports            customizable research reports through jupyter notebooks                                                                                                       │
│                                                                                                                                                                                      │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal v1.5.0 (https://openbb.co) ─╯
You are using the latest version

2022 Jul 05, 09:43 (🦋) / $ update
Could not automatically update. Find the most recent release of the OpenBB Terminal here: https://openbb.co/products/terminal#get-started

[piiq]

Could not automatically update.

I would avoid this part of the output

[DidierRLopes]

Agreed with @piiq

[JerBouma]

Makes sense, will adjust tomorrow.

[JerBouma]

@DidierRLopes Should be all good now :)

[DidierRLopes]

This is looking great, love this

A small request I have is: Can you add a new line after the user utilises "about"?

• And in here you can see that it says that you can do stuff like "about exit" which shouldn't be the case, can we change the code so that is not an option.
• In addition, can we remove that last line about the "about about".
• Can we change banner to: [about (cmd/menu)] Stocks (cmd/menu) Documentation

[JerBouma]

@DidierRLopes Here you go.

[DidierRLopes]

Super, thank you!