diff options
author | DidierRLopes <dro.lopes@campus.fct.unl.pt> | 2023-11-03 09:46:20 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-03 16:46:20 +0000 |
commit | 504a4f442c1012512fada56166d09beb65b63a0a (patch) | |
tree | 7bf6ce1ee01bf306eeaac5c95a69424830f04a32 | |
parent | 1386cbb277fa3eeb4c6305879a269889352bdab9 (diff) |
Improve Pro documentation further (#5641)
* small improvement
* Fix TutorialVideo for mobile view
* main page terminal pro docs
* jose whelp
* placeholder index file that needs to be removed
* fix: fixes sidebar, removes unused index.md
* update link to api keys
* update api keys link
* fix hyperlinks in terminal helper
* fix a few more links
* fix some more links
* linter
* black linter
* improve main docs page for each product
* small refactor
* header to take to main page of product
* run OpenAI script to generate SEO for pro content
---------
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
68 files changed, 7301 insertions, 6836 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e603c72d66..fbe3ac808b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -222,7 +222,7 @@ Now that we have added the model function getting, we need to specify that this If you are adding a new function with a new data source, make a new value in the file. If the data source requires an API key, please refer to the guide below for adding them. Instructions for obtaining the new api key -should be included in the file `OpenBBTerminal/website/content/terminal/usage/guides/api-keys.md`. +should be included in the file `OpenBBTerminal/website/content/terminal/usage/data/api-keys.md`. ### View diff --git a/examples/googleColabInstallation.ipynb b/examples/googleColabInstallation.ipynb index 78d3f1532f5..837b1befc72 100644 --- a/examples/googleColabInstallation.ipynb +++ b/examples/googleColabInstallation.ipynb @@ -1852,7 +1852,7 @@ "cell_type": "code", "source": [ "# The source for the data can be defined by using the `source` argument.\n", - "# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/guides/api-keys\n", + "# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/api-keys\n", "\n", "balance_sheet_growth = openbb.stocks.fa.balance(symbol, ratios = True).transpose()\n", "\n", @@ -2488,4 +2488,4 @@ ] } ] -}
\ No newline at end of file +} diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv index 88e124ea2c6..e8571cb2702 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv @@ -127,23 +127,23 @@ website/content/sdk/usage/basics/index.md,etf website/content/sdk/usage/basics/index.md,holdings website/content/sdk/usage/basics/index.md,dd website/content/sdk/usage/basics/index.md,all -website/content/sdk/usage/guides/api-keys.md,from -website/content/sdk/usage/guides/api-keys.md,global -website/content/sdk/usage/guides/api-keys.md,account -website/content/sdk/usage/guides/api-keys.md,fred -website/content/sdk/usage/guides/api-keys.md,degiro -website/content/sdk/usage/guides/api-keys.md,oanda -website/content/sdk/usage/guides/api-keys.md,change -website/content/sdk/usage/guides/api-keys.md,fmp -website/content/sdk/usage/guides/api-keys.md,mykeys -website/content/sdk/usage/guides/api-keys.md,to -website/content/sdk/usage/guides/api-keys.md,set -website/content/sdk/usage/guides/api-keys.md,news -website/content/sdk/usage/guides/api-keys.md,not defined -website/content/sdk/usage/guides/api-keys.md,keys -website/content/sdk/usage/guides/api-keys.md,stocks -website/content/sdk/usage/guides/api-keys.md,quote -website/content/sdk/usage/guides/api-keys.md,show +website/content/sdk/usage/api-keys.md,from +website/content/sdk/usage/api-keys.md,global +website/content/sdk/usage/api-keys.md,account +website/content/sdk/usage/api-keys.md,fred +website/content/sdk/usage/api-keys.md,degiro +website/content/sdk/usage/api-keys.md,oanda +website/content/sdk/usage/api-keys.md,change +website/content/sdk/usage/api-keys.md,fmp +website/content/sdk/usage/api-keys.md,mykeys +website/content/sdk/usage/api-keys.md,to +website/content/sdk/usage/api-keys.md,set +website/content/sdk/usage/api-keys.md,news +website/content/sdk/usage/api-keys.md,not defined +website/content/sdk/usage/api-keys.md,keys +website/content/sdk/usage/api-keys.md,stocks +website/content/sdk/usage/api-keys.md,quote +website/content/sdk/usage/api-keys.md,show website/content/sdk/usage/guides/changing-sources.md,stocks website/content/sdk/usage/guides/changing-sources.md,source website/content/sdk/usage/guides/changing-sources.md,load @@ -300,18 +300,18 @@ website/content/terminal/usage/basics/index.md,export website/content/terminal/usage/basics/index.md,file website/content/terminal/usage/basics/index.md,load website/content/terminal/usage/basics/index.md,raw -website/content/terminal/usage/guides/api-keys.md,options -website/content/terminal/usage/guides/api-keys.md,fa -website/content/terminal/usage/guides/api-keys.md,keys -website/content/terminal/usage/guides/api-keys.md,stocks -website/content/terminal/usage/guides/api-keys.md,not defined -website/content/terminal/usage/guides/api-keys.md,show -website/content/terminal/usage/guides/api-keys.md,fred -website/content/terminal/usage/guides/api-keys.md,oanda -website/content/terminal/usage/guides/api-keys.md,news -website/content/terminal/usage/guides/api-keys.md,degiro -website/content/terminal/usage/guides/api-keys.md,fmp -website/content/terminal/usage/guides/api-keys.md,mykeys +website/content/terminal/usage/data/api-keys.md,options +website/content/terminal/usage/data/api-keys.md,fa +website/content/terminal/usage/data/api-keys.md,keys +website/content/terminal/usage/data/api-keys.md,stocks +website/content/terminal/usage/data/api-keys.md,not defined +website/content/terminal/usage/data/api-keys.md,show +website/content/terminal/usage/data/api-keys.md,fred +website/content/terminal/usage/data/api-keys.md,oanda +website/content/terminal/usage/data/api-keys.md,news +website/content/terminal/usage/data/api-keys.md,degiro +website/content/terminal/usage/data/api-keys.md,fmp +website/content/terminal/usage/data/api-keys.md,mykeys website/content/terminal/usage/guides/changing-sources.md,save website/content/terminal/usage/guides/changing-sources.md,raw website/content/terminal/usage/guides/changing-sources.md,ticker diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json index e373be2e809..35951a6867b 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json @@ -7,8 +7,8 @@ ], "news": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "show": [ "CONTRIBUTING.md", @@ -16,11 +16,11 @@ "website/content/terminal/usage/basics/index.md", "website/content/terminal/usage/guides/scripts-and-routines.md", "website/content/terminal/usage/guides/changing-sources.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/econometrics.md", "website/content/terminal/usage/intros/economy.md", "website/content/terminal/usage/intros/forecast.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/forecast.md" ], "list": [ @@ -44,8 +44,8 @@ ], "not defined": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "defined, test inconclusive": [ "CONTRIBUTING.md" @@ -60,7 +60,7 @@ "website/content/terminal/usage/guides/changing-sources.md", "website/content/terminal/usage/intros/econometrics.md", "website/content/terminal/usage/intros/forecast.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "cls": [ "CONTRIBUTING.md" @@ -84,12 +84,12 @@ "website/content/terminal/usage/guides/data.md", "website/content/terminal/usage/guides/scripts-and-routines.md", "website/content/terminal/usage/guides/changing-sources.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/economy.md", "website/content/terminal/usage/intros/forecast.md", "website/content/sdk/usage/basics/index.md", "website/content/sdk/usage/guide |