summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-05-22 06:50:43 -0700
committerGitHub <noreply@github.com>2024-05-22 13:50:43 +0000
commit3a8a71dd1551d23036d023a8153c7ced207a562c (patch)
tree8bf671d0416d1721e832757a7ec1e475cf1ec411
parent7531e1da4f72d40bf91fd0230d1d11502b3f926d (diff)
[Docs] Refactor Docs Pages For Diataxis (#6315)
* This change creates a PR * start moving stuff around * data_models/_category_.json * reference/_category_.json * moving some stuff around * Introduction * Documentation updates * few broken links, clean up sidebar titles for how-to * codespell * quickstart - new provider extension * add a comment * map provider interface * quickstart for new router extension * [Docs] diataxis refactor refactor (#6425) * Start refactor * Edits * [DOCS] Reorganize and edit. Fix sidebar navigation (#6445) * Reorganize and edit. Fix sidebar navigation * Fix broken linkages * Edit --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix links --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Fix broken links * Reword CLA part in the Licensing FAQ * change titles and order suggestion - cc @IgorWounds @piiq --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
-rw-r--r--openbb_platform/CONTRIBUTING.md4
-rw-r--r--openbb_platform/obbject_extensions/charting/examples.md (renamed from website/content/platform/extensions/charting/examples.md)3
-rw-r--r--openbb_platform/obbject_extensions/charting/index.md (renamed from website/content/platform/extensions/charting/index.md)3
-rw-r--r--openbb_platform/obbject_extensions/charting/indicators.md (renamed from website/content/platform/extensions/charting/indicators.md)0
-rw-r--r--openbb_platform/obbject_extensions/charting/installation.md (renamed from website/content/platform/extensions/charting/installation.md)0
-rw-r--r--website/content/platform/data_models/_category_.json4
-rw-r--r--website/content/platform/developer_guide/_category_.json4
-rw-r--r--website/content/platform/developer_guide/architecture_overview.mdx (renamed from website/content/platform/development/architecture_overview.md)109
-rw-r--r--website/content/platform/developer_guide/command_coverage.mdx38
-rw-r--r--website/content/platform/developer_guide/commitment_of_traders.mdx (renamed from website/content/platform/usage/explanation/commitment_of_traders.md)50
-rw-r--r--website/content/platform/developer_guide/contributing.mdx (renamed from website/content/platform/development/contributing/index.md)8
-rw-r--r--website/content/platform/developer_guide/dependency_management.mdx (renamed from website/content/platform/development/dependency_management.md)6
-rw-r--r--website/content/platform/developer_guide/deprecating_endpoints.mdx (renamed from website/content/platform/development/contributing/deprecating_endpoints.md)4
-rw-r--r--website/content/platform/developer_guide/documentation_development.mdx64
-rw-r--r--website/content/platform/developer_guide/extensions.mdx311
-rw-r--r--website/content/platform/developer_guide/github.mdx66
-rw-r--r--website/content/platform/developer_guide/http_requests.mdx (renamed from website/content/platform/development/contributing/http_requests.md)23
-rw-r--r--website/content/platform/developer_guide/index.mdx65
-rw-r--r--website/content/platform/developer_guide/obbject.mdx (renamed from website/content/platform/development/obbject.md)54
-rw-r--r--website/content/platform/developer_guide/standardization.mdx59
-rw-r--r--website/content/platform/developer_guide/tests.mdx (renamed from website/content/platform/development/tests.md)27
-rw-r--r--website/content/platform/developer_guide/validators.mdx (renamed from website/content/platform/development/contributing/validators.md)81
-rw-r--r--website/content/platform/development/_category_.json4
-rw-r--r--website/content/platform/development/contributing/_category_.json4
-rw-r--r--website/content/platform/development/contributing/github.md43
-rw-r--r--website/content/platform/development/devtools.md48
-rw-r--r--website/content/platform/development/how-to/_category_.json4
-rw-r--r--website/content/platform/development/index.md68
-rw-r--r--website/content/platform/development/standardization.md151
-rw-r--r--website/content/platform/extensions/_category_.json5
-rw-r--r--website/content/platform/extensions/charting/_category_.json4
-rw-r--r--website/content/platform/extensions/data_extensions.md99
-rw-r--r--website/content/platform/extensions/index.md44
-rw-r--r--website/content/platform/extensions/toolkit_extensions.md175
-rw-r--r--website/content/platform/faqs/_category_.json2
-rw-r--r--website/content/platform/faqs/data_providers.mdx (renamed from website/content/platform/faqs/data_providers.md)21
-rw-r--r--website/content/platform/faqs/platform_vs_sdk.mdx (renamed from website/content/platform/faqs/platform_vs_sdk.md)24
-rw-r--r--website/content/platform/getting_started/_category_.json4
-rw-r--r--website/content/platform/getting_started/api_keys.mdx (renamed from website/content/platform/usage/api_keys.md)9
-rw-r--r--website/content/platform/getting_started/api_requests.mdx95
-rw-r--r--website/content/platform/getting_started/create_new_provider_extension.mdx176
-rw-r--r--website/content/platform/getting_started/create_new_router_extension.mdx216
-rw-r--r--website/content/platform/getting_started/economic_indicators.mdx (renamed from website/content/platform/usage/economic_indicators.md)51
-rw-r--r--website/content/platform/getting_started/financial_statements.mdx (renamed from website/content/platform/usage/explanation/financial_statements.md)63
-rw-r--r--website/content/platform/getting_started/find_symbols.mdx (renamed from website/content/platform/usage/explanation/find_symbols.md)32
-rw-r--r--website/content/platform/getting_started/historical_prices.mdx (renamed from website/content/platform/usage/explanation/historical_prices.md)97
-rw-r--r--website/content/platform/getting_started/index.mdx (renamed from website/content/platform/development/how-to/index.md)13
-rw-r--r--website/content/platform/getting_started/map_a_provider_to_a_route.mdx240
-rw-r--r--website/content/platform/getting_started/market_calendars.mdx (renamed from website/content/platform/usage/explanation/market_calendars.md)38
-rw-r--r--website/content/platform/getting_started/quickstart.mdx76
-rw-r--r--website/content/platform/index.md50
-rw-r--r--website/content/platform/index.mdx66
-rw-r--r--website/content/platform/installation.mdx (renamed from website/content/platform/installation.md)94
-rw-r--r--website/content/platform/licensing/_category_.json2
-rw-r--r--website/content/platform/licensing/index.mdx2
-rw-r--r--website/content/platform/reference/_category_.json4
-rw-r--r--website/content/platform/usage/_category_.json4
-rw-r--r--website/content/platform/usage/basic_response.md138
-rw-r--r--website/content/platform/usage/explanation/_category_.json4
-rw-r--r--website/content/platform/usage/explanation/index.md35
-rw-r--r--website/content/platform/usage/guides/_category_.json1
-rw-r--r--website/content/platform/usage/index.md51
-rw-r--r--website/content/platform/usage/settings_and_environment_variables.md105
-rw-r--r--website/content/platform/user_guides/_category_.json4
-rw-r--r--website/content/platform/user_guides/add_command_examples.mdx (renamed from website/content/platform/development/contributing/function_examples.md)40
-rw-r--r--website/content/platform/user_guides/add_data_provider_extension.mdx (renamed from website/content/platform/development/how-to/add_data_provider_extension.md)31
-rw-r--r--website/content/platform/user_guides/add_data_to_existing_endpoint.mdx (renamed from website/content/platform/development/how-to/add_data_to_existing_endpoint.md)181
-rw-r--r--website/content/platform/user_guides/add_endpoint_to_existing_provider.mdx (renamed from website/content/platform/development/how-to/add_endpoint_to_existing_provider.md)21
-rw-r--r--website/content/platform/user_guides/add_obbject_extension.mdx (renamed from website/content/platform/development/how-to/add_obbject_extension.md)32
-rw-r--r--website/content/platform/user_guides/add_toolkit_extension.mdx (renamed from website/content/platform/development/how-to/add_toolkit_extension.md)124
-rw-r--r--website/content/platform/user_guides/basic_response.mdx66
-rw-r--r--website/content/platform/user_guides/basic_syntax.mdx (renamed from website/content/platform/usage/basic_syntax.md)97
-rw-r--r--website/content/platform/user_guides/dynamic_command_execution.mdx47
-rw-r--r--website/content/platform/user_guides/index.mdx24
-rw-r--r--website/content/platform/user_guides/llm_mode.mdx90
-rw-r--r--website/content/platform/user_guides/rest_api.mdx (renamed from website/content/platform/usage/rest_api.md)28
-rw-r--r--website/content/platform/user_guides/settings_and_environment_variables.mdx106
77 files changed, 2630 insertions, 1606 deletions
diff --git a/openbb_platform/CONTRIBUTING.md b/openbb_platform/CONTRIBUTING.md
index 62a2806e600..1f041d103e9 100644
--- a/openbb_platform/CONTRIBUTING.md
+++ b/openbb_platform/CONTRIBUTING.md
@@ -64,7 +64,7 @@ This document provides guidelines for contributing to the OpenBB Platform.
Throughout this document, we will be differentiating between two types of contributors: Developers and Contributors.
1. **Developers**: Those who are building new features or extensions for the OpenBB Platform or leveraging the OpenBB Platform.
-2. **Contributors**: Those who contribute to the existing codebase, by opening a [Pull Request](#how-to-create-a-pr) thus giving back to the community.
+2. **Contributors**: Those who contribute to the existing codebase, by opening a [Pull Request](#getting_started-create-a-pr) thus giving back to the community.
**Why is this distinction important?**
@@ -676,7 +676,7 @@ When using the OpenBB Platform on a API Interface, the types are a bit more limi
The Contributor Guidelines are intended to be a continuation of the [Developer Guidelines](#developer-guidelines). They are not a replacement, but rather an expansion, focusing specifically on those who seek to directly enhance the OpenBB Platform's codebase. It's crucial for Contributors to be familiar with both sets of guidelines to ensure a harmonious and productive engagement with the OpenBB Platform.
-There are many ways to contribute to the OpenBB Platform. You can add a [new data point](#how-to-add-a-new-data-point), add a [new command](#openbb-platform-commands), add a [new visualization](/openbb_platform/extensions/charting/README.md), add a [new extension](#how-to-build-openbb-extensions), fix a bug, improve or create documentation, etc.
+There are many ways to contribute to the OpenBB Platform. You can add a [new data point](#getting_started-add-a-new-data-point), add a [new command](#openbb-platform-commands), add a [new visualization](/openbb_platform/extensions/charting/README.md), add a [new extension](#getting_started-build-openbb-extensions), fix a bug, improve or create documentation, etc.
### Expectations for Contributors
diff --git a/website/content/platform/extensions/charting/examples.md b/openbb_platform/obbject_extensions/charting/examples.md
index 87b9918ceed..34a57a8d0c4 100644
--- a/website/content/platform/extensions/charting/examples.md
+++ b/openbb_platform/obbject_extensions/charting/examples.md
@@ -44,7 +44,7 @@ By default, more than three symbols will draw the chart as cumulative returns fr
The tickers below are a collection of State Street Global Advisors SPDR funds, representing S&P 500 components.
The data is looking back five years.
-```
+```python
SPDRS = [
"SPY",
"XLE",
@@ -162,4 +162,5 @@ create_bar_chart(
title="S&P Energy Sector YTD Turnover Rate",
)
```
+
![S&P 500 Energy Sector Turnover Rate](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4f59eb36-e637-4a54-87ab-e730e43baf8d)
diff --git a/website/content/platform/extensions/charting/index.md b/openbb_platform/obbject_extensions/charting/index.md
index f55bbe6a8fe..75f6ff10761 100644
--- a/website/content/platform/extensions/charting/index.md
+++ b/openbb_platform/obbject_extensions/charting/index.md
@@ -339,11 +339,12 @@ The `openbb-charting` extension is equipped with interactive tables, utilizing t
data = obb.equity.price.quote("AAPL,MSFT,GOOGL,META,TSLA,AMZN", provider="yfinance")
data.charting.table()
```
+
![Interactive Tables](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/77f5f812-b933-4ced-929c-c1e39b2a3eed)
External data can also be supplied, providing an opportunity to filter or apply Pandas operations before display.
-```
+```python
new_df = df.to_df().T
new_df.index.name="metric"
new_df.columns = new_df.loc["symbol"]
diff --git a/website/content/platform/extensions/charting/indicators.md b/openbb_platform/obbject_extensions/charting/indicators.md
index 9966ba4571f..9966ba4571f 100644
--- a/website/content/platform/extensions/charting/indicators.md
+++ b/