summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDidierRLopes <dro.lopes@campus.fct.unl.pt>2023-11-03 09:46:20 -0700
committerGitHub <noreply@github.com>2023-11-03 16:46:20 +0000
commit504a4f442c1012512fada56166d09beb65b63a0a (patch)
tree7bf6ce1ee01bf306eeaac5c95a69424830f04a32
parent1386cbb277fa3eeb4c6305879a269889352bdab9 (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>
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--examples/googleColabInstallation.ipynb4
-rw-r--r--openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv58
-rw-r--r--openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json60
-rw-r--r--openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv60
-rw-r--r--openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.json64
-rw-r--r--openbb_terminal/miscellaneous/documentation_scripts/generate_documentation_commands.py12
-rw-r--r--openbb_terminal/terminal_helper.py36
-rw-r--r--website/content/bot/index.md22
-rw-r--r--website/content/pro/_category_.json4
-rw-r--r--website/content/pro/advanced-search.md (renamed from website/content/pro/search/index.md)20
-rw-r--r--website/content/pro/copilot.md (renamed from website/content/pro/copilot/index.md)19
-rw-r--r--website/content/pro/copilot/_category_.json4
-rw-r--r--website/content/pro/dashboards/folders.md15
-rw-r--r--website/content/pro/dashboards/grouping.md18
-rw-r--r--website/content/pro/dashboards/index.md (renamed from website/content/pro/dashboards/dashboards.md)19
-rw-r--r--website/content/pro/dashboards/report.md14
-rw-r--r--website/content/pro/dashboards/templates.md15
-rw-r--r--website/content/pro/getting-started/_category_.json2
-rw-r--r--website/content/pro/getting-started/free-trial.md (renamed from website/content/pro/getting-started/free-trial/free-trial.md)23
-rw-r--r--website/content/pro/getting-started/free-trial/_category_.json4
-rw-r--r--website/content/pro/getting-started/getting-started.md13
-rw-r--r--website/content/pro/getting-started/index.md (renamed from website/content/pro/getting-started/quick-start/quick-start.md)21
-rw-r--r--website/content/pro/getting-started/quick-start/_category_.json4
-rw-r--r--website/content/pro/index.md78
-rw-r--r--website/content/pro/main-menu/charting.md (renamed from website/content/pro/main-menu/charting/index.md)24
-rw-r--r--website/content/pro/main-menu/charting/_category_.json4
-rw-r--r--website/content/pro/main-menu/data-connectors/index.md (renamed from website/content/pro/main-menu/data-connectors/introduction.md)20
-rw-r--r--website/content/pro/main-menu/data-connectors/integrate-your-own-backend.md (renamed from website/content/pro/main-menu/data-connectors/advanced.md)23
-rw-r--r--website/content/pro/main-menu/data-connectors/native-integrations.md (renamed from website/content/pro/main-menu/data-connectors/third-party.md)16
-rw-r--r--website/content/pro/main-menu/data-connectors/single-widget.md21
-rw-r--r--website/content/pro/main-menu/home/_category_.json4
-rw-r--r--website/content/pro/main-menu/homepage.md (renamed from website/content/pro/main-menu/home/home.md)22
-rw-r--r--website/content/pro/main-menu/index.md31
-rw-r--r--website/content/pro/main-menu/news.md (renamed from website/content/pro/main-menu/news/news.md)19
-rw-r--r--website/content/pro/main-menu/news/_category_.json4
-rw-r--r--website/content/pro/search/_category_.json4
-rw-r--r--website/content/pro/settings.md13
-rw-r--r--website/content/pro/settings/_category_.json4
-rw-r--r--website/content/pro/settings/index.md6
-rw-r--r--website/content/pro/widgets-library/index.md10
-rw-r--r--website/content/pro/widgets/_category_.json2
-rw-r--r--website/content/pro/widgets/chat-with-widget.md18
-rw-r--r--website/content/pro/widgets/data-provider.md18
-rw-r--r--website/content/pro/widgets/index.md (renamed from website/content/pro/widgets/introduction.md)31
-rw-r--r--website/content/pro/widgets/tabular-data/chart-from-raw-data.md16
-rw-r--r--website/content/pro/widgets/tabular-data/forecasting.md20
-rw-r--r--website/content/pro/widgets/tabular-data/index.md (renamed from website/content/pro/widgets/tabular-data/data-manipulation.md)21
-rw-r--r--website/content/sdk/faqs/data_sources.md2
-rw-r--r--website/content/sdk/index.md20
-rw-r--r--website/content/terminal/data-available/common/ba.md2
-rw-r--r--website/content/terminal/data-available/econometrics.md2
-rw-r--r--website/content/terminal/data-available/economy.md2
-rw-r--r--website/content/terminal/data-available/fixedincome.md2
-rw-r--r--website/content/terminal/data-available/forecast.md2
-rw-r--r--website/content/terminal/data-available/stocks/dark-pool-shorts.md2
-rw-r--r--website/content/terminal/data-available/stocks/introduction.md4
-rw-r--r--website/content/terminal/faqs/data_sources.md2
-rw-r--r--website/content/terminal/faqs/general_operation.md4
-rw-r--r--website/content/terminal/index.md17
-rw-r--r--website/content/terminal/usage/data/data-sources.md6
-rw-r--r--website/content/terminal/usage/outputs/export-data.md2
-rw-r--r--website/pnpm-lock.yaml12
-rw-r--r--website/src/components/General/TutorialVideo.tsx39
-rw-r--r--website/src/theme/DocSidebarItem/index.js30
-rw-r--r--website/src/theme/Navbar/Logo/index.js3
-rw-r--r--website/utils/generate_seo_for_documentation.ipynb6
-rw-r--r--website/yarn.lock13036
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