Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Pro documentation further #5641

Merged
merged 18 commits into from
Nov 3, 2023
Merged

Improve Pro documentation further #5641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
25bf6ce
small improvement
DidierRLopes Oct 30, 2023
8e3e723
Fix TutorialVideo for mobile view
DidierRLopes Oct 31, 2023
5fb5551
main page terminal pro docs
DidierRLopes Oct 31, 2023
b94f798
jose whelp
DidierRLopes Oct 31, 2023
879d2d8
placeholder index file that needs to be removed
DidierRLopes Nov 1, 2023
3c6f77a
fix: fixes sidebar, removes unused index.md
jose-donato Nov 1, 2023
dc0f137
merge develop into this branch
DidierRLopes Nov 2, 2023
c6d68f9
update link to api keys
DidierRLopes Nov 2, 2023
8a53eab
update api keys link
DidierRLopes Nov 2, 2023
e68f43b
fix hyperlinks in terminal helper
DidierRLopes Nov 2, 2023
d22e376
fix a few more links
DidierRLopes Nov 2, 2023
db6075c
fix some more links
DidierRLopes Nov 2, 2023
8295e35
linter
DidierRLopes Nov 2, 2023
6742f79
black linter
DidierRLopes Nov 2, 2023
5bf783a
improve main docs page for each product
DidierRLopes Nov 2, 2023
7047577
small refactor
DidierRLopes Nov 3, 2023
d352228
header to take to main page of product
DidierRLopes Nov 3, 2023
46843ab
run OpenAI script to generate SEO for pro content
DidierRLopes Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions examples/googleColabInstallation.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -2488,4 +2488,4 @@
]
}
]
}
}
58 changes: 29 additions & 29 deletions openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
60 changes: 30 additions & 30 deletions openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@
],
"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",
"openbb_terminal/SDK_README.md",
"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": [
Expand All @@ -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"
Expand All @@ -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"
Expand All @@ -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/guides/changing-sources.md",
"website/content/sdk/usage/guides/api-keys.md",
"website/content/sdk/usage/api-keys.md",
"website/content/sdk/usage/intros/etf.md",
"website/content/sdk/usage/intros/ta.md",
"website/content/sdk/usage/intros/forecast.md"
Expand Down Expand Up @@ -150,7 +150,7 @@
"quote": [
"CONTRIBUTING.md",
"website/content/terminal/usage/intros/forex.md",
"website/content/sdk/usage/guides/api-keys.md"
"website/content/sdk/usage/api-keys.md"
],
"candle": [
"CONTRIBUTING.md",
Expand All @@ -163,7 +163,7 @@
"options": [
"CONTRIBUTING.md",
"website/content/terminal/usage/guides/scripts-and-routines.md",
"website/content/terminal/usage/guides/api-keys.md",
"website/content/terminal/usage/data/api-keys.md",
"website/content/terminal/usage/intros/fixedincome.md",
"website/content/sdk/usage/intros/fixedincome.md"
],
Expand All @@ -178,7 +178,7 @@
"fa": [
"CONTRIBUTING.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/sdk/usage/guides/changing-sources.md"
],
"ta": [
Expand Down Expand Up @@ -328,8 +328,8 @@
],
"oanda": [
"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",
"website/content/sdk/usage/intros/forex.md"
],
"calendar": [
Expand All @@ -347,7 +347,7 @@
"website/content/terminal/usage/intros/economy.md",
"website/content/sdk/usage/basics/index.md",
"website/content/sdk/usage/guides/chart-styling.md",
"website/content/sdk/usage/guides/api-keys.md",
"website/content/sdk/usage/api-keys.md",
"website/content/sdk/usage/intros/fixedincome.md",
"website/content/sdk/usage/intros/econometrics.md",
"website/content/sdk/usage/intros/futures.md",
Expand All @@ -366,7 +366,7 @@
"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/guides/api-keys.md",
"website/content/sdk/usage/api-keys.md",
"website/content/sdk/usage/intros/econometrics.md",
"website/content/sdk/usage/intros/economy.md",
"website/content/sdk/usage/intros/forecast.md"
Expand Down Expand Up @@ -403,15 +403,15 @@
],
"keys": [
"openbb_terminal/SDK_README.md",
"website/content/terminal/usage/guides/api-keys.md",
"website/content/terminal/usage/data/api-keys.md",
"website/content/sdk/usage/basics/index.md",
"website/content/sdk/usage/guides/api-keys.md",
"website/content/sdk/usage/api-keys.md",
"website/content/sdk/usage/intros/economy.md"
],
"mykeys": [
"openbb_terminal/SDK_README.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"
],
"dpi": [
"openbb_terminal/SDK_README.md"
Expand All @@ -433,8 +433,8 @@
],
"fmp": [
"openbb_terminal/SDK_README.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"
],
"categories": [
"openbb_terminal/SDK_README.md",
Expand Down Expand Up @@ -478,7 +478,7 @@
],
"global": [
"website/content/sdk/faqs/developer_issues.md",
"website/content/sdk/usage/guides/api-keys.md"
"website/content/sdk/usage/api-keys.md"
],
"rm": [
"website/content/sdk/faqs/developer_issues.md"
Expand Down Expand Up @@ -575,17 +575,17 @@
"website/content/terminal/usage/guides/changing-sources.md",
"website/content/terminal/usage/intros/econometrics.md",
"website/content/terminal/usage/intros/economy.md",
"website/content/sdk/usage/guides/api-keys.md"
"website/content/sdk/usage/api-keys.md"
],
"fred": [
"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/sdk/usage/guides/api-keys.md",
"website/content/sdk/usage/api-keys.md",
"website/content/sdk/usage/intros/economy.md"
],
"degiro": [
"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"
],
"fixedincome": [
"website/content/terminal/usage/intros/fixedincome.md",
Expand Down Expand Up @@ -761,7 +761,7 @@
"website/content/sdk/usage/intros/ta.md"
],
"account": [
"website/content/sdk/usage/guides/api-keys.md"
"website/content/sdk/usage/api-keys.md"
],
"projection": [
"website/content/sdk/usage/intros/fixedincome.md"
Expand Down Expand Up @@ -842,4 +842,4 @@
"sto": [
"website/content/sdk/usage/intros/forecast.md"
]
}
}
60 changes: 30 additions & 30 deletions openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,35 +25,35 @@ website/content/sdk/usage/basics/index.md,economy.events
website/content/sdk/usage/basics/index.md,ta.donchian
website/content/sdk/usage/basics/index.md,stocks.load
website/content/sdk/usage/basics/index.md,etf.holdings
website/content/sdk/usage/guides/api-keys.md,keys.github
website/content/sdk/usage/guides/api-keys.md,keys.glassnode
website/content/sdk/usage/guides/api-keys.md,keys.fred
website/content/sdk/usage/guides/api-keys.md,keys.finnhub
website/content/sdk/usage/guides/api-keys.md,keys.eodhd
website/content/sdk/usage/guides/api-keys.md,keys.degiro
website/content/sdk/usage/guides/api-keys.md,keys.databento
website/content/sdk/usage/guides/api-keys.md,keys.quandl
website/content/sdk/usage/guides/api-keys.md,keys.oanda
website/content/sdk/usage/guides/api-keys.md,keys.polygon
website/content/sdk/usage/guides/api-keys.md,keys.cpanic
website/content/sdk/usage/guides/api-keys.md,keys.santiment
website/content/sdk/usage/guides/api-keys.md,keys.stocksera
website/content/sdk/usage/guides/api-keys.md,keys.tokenterminal
website/content/sdk/usage/guides/api-keys.md,keys.tradier
website/content/sdk/usage/guides/api-keys.md,keys.walert
website/content/sdk/usage/guides/api-keys.md,stocks.quote
website/content/sdk/usage/guides/api-keys.md,keys.news
website/content/sdk/usage/guides/api-keys.md,keys.coinglass
website/content/sdk/usage/guides/api-keys.md,keys.messari
website/content/sdk/usage/guides/api-keys.md,keys.cmc
website/content/sdk/usage/guides/api-keys.md,keys.fmp
website/content/sdk/usage/guides/api-keys.md,keys.mykeys
website/content/sdk/usage/guides/api-keys.md,keys.reddit
website/content/sdk/usage/guides/api-keys.md,keys.coinbase
website/content/sdk/usage/guides/api-keys.md,news
website/content/sdk/usage/guides/api-keys.md,keys.av
website/content/sdk/usage/guides/api-keys.md,keys.binance
website/content/sdk/usage/guides/api-keys.md,keys.bitquery
website/content/sdk/usage/api-keys.md,keys.github
website/content/sdk/usage/api-keys.md,keys.glassnode
website/content/sdk/usage/api-keys.md,keys.fred
website/content/sdk/usage/api-keys.md,keys.finnhub
website/content/sdk/usage/api-keys.md,keys.eodhd
website/content/sdk/usage/api-keys.md,keys.degiro
website/content/sdk/usage/api-keys.md,keys.databento
website/content/sdk/usage/api-keys.md,keys.quandl
website/content/sdk/usage/api-keys.md,keys.oanda
website/content/sdk/usage/api-keys.md,keys.polygon
website/content/sdk/usage/api-keys.md,keys.cpanic
website/content/sdk/usage/api-keys.md,keys.santiment
website/content/sdk/usage/api-keys.md,keys.stocksera
website/content/sdk/usage/api-keys.md,keys.tokenterminal
website/content/sdk/usage/api-keys.md,keys.tradier
website/content/sdk/usage/api-keys.md,keys.walert
website/content/sdk/usage/api-keys.md,stocks.quote
website/content/sdk/usage/api-keys.md,keys.news
website/content/sdk/usage/api-keys.md,keys.coinglass
website/content/sdk/usage/api-keys.md,keys.messari
website/content/sdk/usage/api-keys.md,keys.cmc
website/content/sdk/usage/api-keys.md,keys.fmp
website/content/sdk/usage/api-keys.md,keys.mykeys
website/content/sdk/usage/api-keys.md,keys.reddit
website/content/sdk/usage/api-keys.md,keys.coinbase
website/content/sdk/usage/api-keys.md,news
website/content/sdk/usage/api-keys.md,keys.av
website/content/sdk/usage/api-keys.md,keys.binance
website/content/sdk/usage/api-keys.md,keys.bitquery
website/content/sdk/usage/guides/changing-sources.md,stocks.load
website/content/sdk/usage/intros/alternative.md,alt.covid.slopes
website/content/sdk/usage/intros/alternative.md,alt.covid.global_deaths
Expand Down Expand Up @@ -110,4 +110,4 @@ website/content/sdk/usage/intros/ta.md,ta.atr
website/content/sdk/usage/intros/ta.md,ta.rsi
website/content/sdk/usage/intros/ta.md,stocks.load
website/content/sdk/usage/intros/ta.md,ta.donchian
website/content/terminal/usage/guides/api-keys.md,news
website/content/terminal/usage/data/api-keys.md,news
Loading
Loading