Updates Terminal Basics Guide for 3.0. #4835

deeleeramone · 2023-04-20T03:01:07Z

Description

This PR updates the Terminal basics guide for version 3.0. It includes new details for working with the charts and tables.

Also updated in this PR is:

Terminal Forecast Introduction
Technical Analysis Intro
Terminal Customization Guide

jmaslek · 2023-04-20T19:41:52Z

website/content/terminal/usage/basics/index.md

+### Light and Dark Mode

-Let's change the starting and ending period of the data that is being loaded in by doing the following:
+Set the theme, globally, as either light or dark.

+Dark mode:
+
+```console
+/settings/chart -s dark
 ```
-(🦋) /stocks/ $ load AMZN -s 2005-01-01 -e 2010-01-01

-Loading Daily data for AMZN with starting period 2005-01-03.
+Light mode:

+```console
+/settings/chart -s light
 ```

-We can check that this period has changed by looking into the <a href="https://www.investopedia.com/trading/candlestick-charting-what-is-it/" target="_blank" rel="noreferrer noopener">candle chart</a> with `candle`. This, again shares the same `-h` argument. This results in the following which indeed depicts our selected period.
+The default state is dark mode.

+```console
+/stocks/load aapl -w/candle


I would drop this because we can change it in the chart itself and changing a theme color isnt important enough in my mind to warrant being on the basics page.

Sections on chart/table theme commands removed.

website/content/terminal/usage/basics/index.md

…OpenBB-finance/OpenBBTerminal into hotfix/docs_terminal_basics_3p0

…iption

…OpenBB-finance/OpenBBTerminal into hotfix/docs_terminal_basics_3p0

jmaslek · 2023-04-21T18:54:56Z

website/content/terminal/usage/basics/index.md


-:::note **About Pipelines**
-You can quickly jump between menus by using a forward slash (`/`). For example, if I want to access the options menu, You can type `/stocks/options` to instantly arrive at this menu. You can do this from any location within the OpenBB Terminal!
-:::


I think this should definitely still be incorporated here.

This is included near the top:

I like on the website how it is visualized as a special box. Maybe we can keep the box and start it from the sentence you have as "Absolute path are also valid" ?

jmaslek · 2023-04-21T20:16:35Z

website/content/terminal/usage/basics/index.md

+
+To draw on the chart, select one of the four drawing buttons and drag the mouse over the desired area.  Click on any existing shape to modify it by dragging with the mouse and editing the color, or remove it by clicking the toolbar button, `Erase Active Shape`.  The edit colors button will pop up as a floating icon, and clicking on that will display the color palette.
+
+![Edit Colors](https://user-images.githubusercontent.com/85772166/233248349-d7cd2e2e-7e22-4efb-acdb-5f7a85bf2932.png)


I know this is the default stuff, but this is very hard to read on the chart. NOt sure if you can change either to a light theme chart or a lighter font color

Updated charts, much easier it to read now.

jmaslek · 2023-04-21T20:35:06Z

website/content/terminal/usage/basics/index.md

 ```

-![Candlestick Chart Amazon](https://user-images.githubusercontent.com/46355364/223211728-1317abea-36da-461c-bc3b-140ed7973173.svg)
+![Selecting a new Data Source](https://user-images.githubusercontent.com/85772166/233719604-9f28b80d-4c5f-41f5-8cfe-71d5aaa6da99.png)


I think this image in unnecessary. I was envisioning an example of how to set, so something like

set --cmd stocks/fa/income --source FinancialModelingPrep

But maybe a close zoom in of the function showing --source does also make sense to show.

Ah, I was making an example of a preference being overridden and not set with the /sources menu.

Updated to just be a zoomed shot of the source choices.

…minal into hotfix/docs_terminal_basics_3p0

codecov · 2023-04-23T01:16:39Z

Codecov Report

Patch coverage: 43.15% and project coverage change: -0.15 ⚠️

Comparison is base (a1aff50) 58.43% compared to head (9a564d9) 58.29%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4835      +/-   ##
===========================================
- Coverage    58.43%   58.29%   -0.15%     
===========================================
  Files          588      588              
  Lines        53608    53659      +51     
===========================================
- Hits         31328    31280      -48     
- Misses       22280    22379      +99

Impacted Files	Coverage Δ
generate_sdk.py	`90.82% <ø> (ø)`
openbb_terminal/account/account_controller.py	`81.02% <0.00%> (-1.78%)`	⬇️
...mmon/technical_analysis/custom_indicators_model.py	`20.83% <0.00%> (ø)`
...minal/common/technical_analysis/volatility_view.py	`32.81% <ø> (ø)`
...lots/plotly_ta/plugins/custom_indicators_plugin.py	`14.13% <0.00%> (ø)`
openbb_terminal/core/sdk/sdk_init.py	`92.75% <ø> (ø)`
openbb_terminal/core/session/routines_handler.py	`63.52% <0.00%> (-20.02%)`	⬇️
...b_terminal/econometrics/econometrics_controller.py	`47.40% <ø> (ø)`
openbb_terminal/featflags_controller.py	`84.81% <ø> (-3.15%)`	⬇️
openbb_terminal/forecast/forecast_controller.py	`1.12% <0.00%> (ø)`
... and 27 more

... and 4 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Updates Terminal Basics Guide for 3.0. Images to follow.

b969767

reviewpad bot added the feat S Small T-Shirt size Feature label Apr 20, 2023

deeleeramone added 2 commits April 19, 2023 20:02

spelling

db140b9

Adds the images.

7dc3331

reviewpad bot added feat M Medium T-Shirt size feature and removed feat S Small T-Shirt size Feature labels Apr 20, 2023

deeleeramone marked this pull request as ready for review April 20, 2023 03:29

deeleeramone requested a review from JerBouma April 20, 2023 03:29

deeleeramone added docs Code documentation guides Guides and online documentation labels Apr 20, 2023

deeleeramone and others added 3 commits April 19, 2023 20:37

missing ! from markdown image

d164b5f

Grammar correction.

2da7d7f

small wording changes

e8d184e

jmaslek reviewed Apr 20, 2023

View reviewed changes

website/content/terminal/usage/basics/index.md Show resolved Hide resolved

deeleeramone added 2 commits April 20, 2023 21:17

updates Terminal Forecast intro

e8b8eb0

Merge branch 'hotfix/docs_terminal_basics_3p0' of https://github.com/…

58de498

…OpenBB-finance/OpenBBTerminal into hotfix/docs_terminal_basics_3p0

reviewpad bot added feat L Large T-Shirt size Feature and removed feat M Medium T-Shirt size feature labels Apr 21, 2023

deeleeramone added 2 commits April 20, 2023 21:41

adds screenshots to Forecast intro

402de27

spelling in Forecast intro

7311de8

deeleeramone changed the title ~~Updates Terminal Basics Guide for 3.0. Images to follow.~~ Updates Terminal Basics Guide for 3.0. Apr 21, 2023

deeleeramone added 7 commits April 20, 2023 21:49

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

5965287

Forecast intro - grammar in last sentence

efec165

Merge branch 'hotfix/docs_terminal_basics_3p0' of https://github.com/…

da78a3a

…OpenBB-finance/OpenBBTerminal into hotfix/docs_terminal_basics_3p0

Adds section for Support, removes themes sections, updates page descr…

17c75ec

…iption

Adds images for support section.

1e747a8

Add list of tips for support ticket info

e047ca8

Merge branch 'hotfix/docs_terminal_basics_3p0' of https://github.com/…

10dea59

…OpenBB-finance/OpenBBTerminal into hotfix/docs_terminal_basics_3p0

jmaslek reviewed Apr 21, 2023

View reviewed changes

Makes annotated font brighter and easier to read.

16da053

jmaslek reviewed Apr 21, 2023

View reviewed changes

deeleeramone and others added 6 commits April 21, 2023 13:43

swap data source change pic.md

e25db0f

Merge branch 'develop' of https://github.com/OpenBB-finance/OpenBBTer…

863b42d

…minal into hotfix/docs_terminal_basics_3p0

Updates Terminal Technical Analysis Intro

5de45b6

Adds screenshots to TA Intro

0c73aaf

typos

40ea2ce

make intro spin up pywry window with usage basics (#4871)

975387b

deeleeramone and others added 14 commits April 23, 2023 18:59

fix ruff - unused import

1deb413

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

b2ece15

This indent keeps changing

365a7ca

words

876ca0f

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

4d46779

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

6cf3b29

updates Terminal Customization Guide

cfb2d1c

adds image for table index locking

07ab2ec

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

6c3c973

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

faed05c

chart/table cheat sheets

70fd120

Add another cheat sheet header

dc59e75

Merge branch 'develop' into hotfix/docs_terminal_basics_3p0

8723cbc

fix

9a564d9

jmaslek approved these changes Apr 25, 2023

View reviewed changes

jmaslek enabled auto-merge April 25, 2023 16:15

jmaslek added this pull request to the merge queue Apr 25, 2023

Merged via the queue into develop with commit 4dce2fa Apr 25, 2023

jmaslek deleted the hotfix/docs_terminal_basics_3p0 branch May 1, 2023 20:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates Terminal Basics Guide for 3.0. #4835

Updates Terminal Basics Guide for 3.0. #4835

deeleeramone commented Apr 20, 2023 •

edited

Loading

jmaslek Apr 20, 2023

deeleeramone Apr 21, 2023

jmaslek Apr 21, 2023

deeleeramone Apr 21, 2023

jmaslek Apr 21, 2023

jmaslek Apr 21, 2023

deeleeramone Apr 21, 2023

jmaslek Apr 21, 2023

deeleeramone Apr 21, 2023

deeleeramone Apr 21, 2023

codecov bot commented Apr 23, 2023 •

edited

Loading


		To draw on the chart, select one of the four drawing buttons and drag the mouse over the desired area. Click on any existing shape to modify it by dragging with the mouse and editing the color, or remove it by clicking the toolbar button, `Erase Active Shape`. The edit colors button will pop up as a floating icon, and clicking on that will display the color palette.

		![Edit Colors](https://user-images.githubusercontent.com/85772166/233248349-d7cd2e2e-7e22-4efb-acdb-5f7a85bf2932.png)

Updates Terminal Basics Guide for 3.0. #4835

Updates Terminal Basics Guide for 3.0. #4835

Conversation

deeleeramone commented Apr 20, 2023 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Apr 23, 2023 • edited Loading

Codecov Report

deeleeramone commented Apr 20, 2023 •

edited

Loading

codecov bot commented Apr 23, 2023 •

edited

Loading