docs/working-docs: Working V4 Docs PR (#5747)

* post-install clarification, fix links * more links * change word * toolkit cleanup * rename 'contributing' to 'development' * update extensions * some urls * Update sdk-platform and v4-develop in urls (#5730) * Update sdk-platform and v4-develop in urls * Seprate Intrinio financials data tags into a different command (#5723) * add `ebit` field in income statement standard model * only add required data tags * remove calculations data * use `name` key instead of `tag` key * set `period` as required in data * remove `period` and `cik` from provider models * add `equity/fundamental/search_financial_attributes` with tests * clean descriptions file * add `equity/fundamental/financial_attributes` with tests * set `value` as `Optional` * Fix threadpool test error (#5734) * Remove ultima from deps (#5736) * remove ultima from deps * skip ultima test * black * change skip location * try except statement to avoid error on the ci * new currency reference rates pr (#5724) * point files to linters (#5739) * remove news from equity (#5741) * Add tiingo provider (#5740) * first commit * things * Add news endpoints * CryptoHistorical * Add currency and trailing dividend yield * things working * deps * fix pre commit things * tests? * black on the tests * pratty told me to add it * integration tests * added helpers * crypto revamped * currency revamped * trailing dividend yield revamped * equity historical revamped * company news overhauled * global news overhauled * remove `tags` param from news models * crypto correct `exchanges` description * james smh * re-recorded fetcher tests * fixed integration tests * econometrics smh * james smh again --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Add `derivatives` extension for `futures` and `options` (#5742) * removed options and futures * add derivatives extension * cleanup * bug #5649 (#5722) * bug #5649 * fixing --a upmom, downmom --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Rename the fmp search -> screener (#5744) * Rename the fmp search -> screener * misses some * i cant copy paste * docs/fix-urls: Updates the Terminal About URLs to match `/develop` (#5720) * update Terminal about URLs and some other broken links * ruff * intro * changing the heading levels * dependency management sections * structure * developer guides * structure * contributor guides * keywords and descriptions * broken urls * cool cards * Cool cards (#5727) * tidy up terminal/content * some more tidy up * fix styling for platform that was missing * more tidy up * improve color for dark and light mode * create new reference card for more basic cards * rename back to menus * implement all index.md for terminal, except reference * improve bot title * more refactoring * fix remaining index * header styling * more styling * heheheheheheeh * Revert "heheheheheheeh" This reverts commit 7d095fc. * Ccards (#5733) * links * more links * improved styling and chevron aligned to title * fix index.mdx urls for Terminal * update package.json * update index.mdx * fix generation * spelling * toolkit_extensions * update data extensions * couple of links * add tiingo to data extensions list --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Stock leftover cleanup (#5745) * change to equity in `.md` files * `HistoricalStockSplits`->`HistoricalSplits` * `StockInsiderTrading`->`InsiderTrading` * sorry fmp * `EquityHistorical` cleanup * `EquityNBBO` cleanup * .md leftover * the last of stocks * post-install clarification, fix links * more links * change word * toolkit cleanup * rename 'contributing' to 'development' * Hotfix/urllib to dev group (#5732) * use the urllib3 dependency on the dev group instead * adapt the version script for the nightlies - if it's a nightly the package distribution name will have a different name * add dev dependencies to the dev installation bc of the ci * updating the import on validate_call according to: https://docs.pydantic.dev/latest/concepts/validation_decorator/ the way we were importing it breaks if pydantic=2.5 @montezdesousa * loosing urllib3 version specification on the provider and adding it to platform dev deps * rmeoving urllib from top level deps; and removing --with dev flag * changing to ^ instead * Revert "changing to ^ instead" This reverts commit 7300904. * unnecessary dep --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/v4-bop - Add ECB Balance of Payments (Replaces #5716) (#5726) * add ecb balance of payments * missing __init__.py files * Nasdaq calendar earnings and fix FMP calendar earnings (#5718) Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/us-treasury-auctions: Adds Treasury Auctions endpoint and provider for US Government Data. (#5746) * add government_us provider and treasury auctions endpoint * black * add param for cusip * move logic for setting default start/end date * Update hub<>platform credentials map (#5749) * update hub<>platform credentials map * typo * Add API settings schema to system settings (#5743) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Skip checking creds (#5737) * skip checking creds * fix bug * ok mypy * add comment * rename required_credentials * fix * fix top_retail bug * don't require creds in some nasdaq fetchers * black * this was not here before * fix tests * update fetcher test * update contributing guidelines * Fix Quote (#5752) * Fix Quote * fixed return type and model validation --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Wrap up renaming global news to world news on a model level (#5750) * Wrap up renaming global news to world news on a model level * cleanup --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * update extensions * some urls * Revert changes to v3 docs --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Ramazan <guvencramazan@yandex.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * POST request example * update post example * find symbols * market calendars * codespell * codespell ftw * improve main page light mode --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Ramazan <guvencramazan@yandex.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
OpenBB-finance · Nov 20, 2023 · 7bcef37 · 7bcef37
1 parent ddcd1e7
commit 7bcef37
Show file tree

Hide file tree

Showing 56 changed files with 839 additions and 115 deletions.
diff --git a/openbb_platform/README.md b/openbb_platform/README.md
@@ -1,3 +1,5 @@
+# OpenBB Platform
+
 [![Downloads](https://static.pepy.tech/badge/openbb)](https://pepy.tech/project/openbb)
 [![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal)
 
@@ -6,7 +8,7 @@
 | ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png) |
 | Check our website at [openbb.co](www.openbb.co) |
 
-## OpenBB Platform Overview
+## Overview
 
 The OpenBB Platform provides a convenient way to access raw financial data from multiple data providers. The package comes with a ready to use REST API - this allows developers from any language to easily create applications on top of OpenBB Platform.
 
@@ -29,7 +31,6 @@ pip install openbb[all] --pre
 ``````
 
 > The `--pre` flag is required to install the latest alpha version.
-
 > Note: These instruction are specific to v4. For installation instructions and documentation for v3 go to our [website](https://docs.openbb.co/sdk).
 
 ## Python

diff --git a/openbb_platform/extensions/crypto/README.md b/openbb_platform/extensions/crypto/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-crypto
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/currency/README.md b/openbb_platform/extensions/currency/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-currency
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/econometrics/README.md b/openbb_platform/extensions/econometrics/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-econometrics
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/economy/README.md b/openbb_platform/extensions/economy/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-economy
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/equity/README.md b/openbb_platform/extensions/equity/README.md
@@ -25,6 +25,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-equity
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/fixedincome/README.md b/openbb_platform/extensions/fixedincome/README.md
@@ -12,6 +12,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-fixedincome
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/index/README.md b/openbb_platform/extensions/index/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-index
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/news/README.md b/openbb_platform/extensions/news/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-news
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/quantitative/README.md b/openbb_platform/extensions/quantitative/README.md
@@ -14,6 +14,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-qa
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/regulators/README.md b/openbb_platform/extensions/regulators/README.md
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-regulators
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/extensions/technical/README.md b/openbb_platform/extensions/technical/README.md
@@ -14,6 +14,6 @@ To install the extension, run the following command in this folder:
 pip install openbb-technical
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
 Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/alpha_vantage/README.md b/openbb_platform/providers/alpha_vantage/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-alpha-vantage
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/benzinga/README.md b/openbb_platform/providers/benzinga/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-benzinga
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/cboe/README.md b/openbb_platform/providers/cboe/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-cboe
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/ecb/README.md b/openbb_platform/providers/ecb/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-ecb
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/finra/README.md b/openbb_platform/providers/finra/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-finra
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/fmp/README.md b/openbb_platform/providers/fmp/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-fmp
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/fred/README.md b/openbb_platform/providers/fred/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-fred
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/intrinio/README.md b/openbb_platform/providers/intrinio/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-intrinio
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/nasdaq/README.md b/openbb_platform/providers/nasdaq/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-nasdaq
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/polygon/README.md b/openbb_platform/providers/polygon/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-polygon
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/sec/README.md b/openbb_platform/providers/sec/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-sec
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/seeking_alpha/README.md b/openbb_platform/providers/seeking_alpha/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-seeking-alpha
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/stockgrid/README.md b/openbb_platform/providers/stockgrid/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-stockgrid
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/tradingeconomics/README.md b/openbb_platform/providers/tradingeconomics/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-tradingeconomics
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/ultima/README.md b/openbb_platform/providers/ultima/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-ultima
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/wsj/README.md b/openbb_platform/providers/wsj/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-wsj
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/openbb_platform/providers/yfinance/README.md b/openbb_platform/providers/yfinance/README.md
@@ -10,6 +10,6 @@ To install the extension:
 pip install openbb-yfinance
 ```
 
-For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
 
-Documentation available [here](https://docs.openbb.co/sdk).
+Documentation available [here](https://docs.openbb.co/platform).
diff --git a/website/content/platform/contributing/_category_.json b/website/content/platform/contributing/_category_.json
diff --git a/website/content/platform/contributing/contributor-guidelines/index.md b/website/content/platform/contributing/contributor-guidelines/index.md
diff --git a/website/content/platform/development/_category_.json b/website/content/platform/development/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Development",
+  "position": 6
+}
diff --git a/...ng/contributor-guidelines/_category_.json → ...nt/contributor-guidelines/_category_.json b/...ng/contributor-guidelines/_category_.json → ...nt/contributor-guidelines/_category_.json
diff --git a/...uidelines/expecations_for_contributors.md → ...uidelines/expecations_for_contributors.md b/...uidelines/expecations_for_contributors.md → ...uidelines/expecations_for_contributors.md
@@ -19,7 +19,7 @@ keywords:
 
 import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
-<HeadTitle title="Expectations For Contributors - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
+<HeadTitle title="Expectations For Contributors - Contributor Guidelines - Development | OpenBB Platform Docs" />
 
 1. Use Cases:
    - Ensure that your contributions directly enhance the OpenBB Platform's functionality or extension ecosystem.

diff --git a/website/content/platform/development/contributor-guidelines/index.md b/website/content/platform/development/contributor-guidelines/index.md
@@ -0,0 +1,19 @@
+---
+title: Introduction
+sidebar_position: 1
+description: This introduction to the Contributor Guidelines provides an overview of how to enhance the OpenBB Platform's codebase. It highlights the various ways to contribute, from adding new data points and commands to creating new extensions and improving documentation.
+keywords:
+- OpenBB Contributor Guidelines
+- Codebase enhancement
+- OpenBB extensions
+- Documentation improvement
+- OpenBB Platform contribution
+---
+
+import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
+
+<HeadTitle title="Introduction - Contributor Guidelines - Development | OpenBB Platform Docs" />
+
+The Contributor Guidelines are intended to be a continuation of the [Developer Guidelines](/platform/development/developer-guidelines/expecations_for_developers). 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](/platform/development/developer-guidelines/add_data_point), add a [new command](/platform/development/developer-guidelines/add_custom_data_sources#openbb-platform-commands), add a [new visualization](/platform/extensions/toolkit_extensions#charting), add a [new extension](/platform/development/developer-guidelines/build_openbb_extensions), fix a bug, improve or create documentation, etc.
diff --git a/...ntributor-guidelines/manage_extensions.md → ...ntributor-guidelines/manage_extensions.md b/...ntributor-guidelines/manage_extensions.md → ...ntributor-guidelines/manage_extensions.md
@@ -12,7 +12,7 @@ keywords:
 
 import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
 
-<HeadTitle title="Manage Extensions - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
+<HeadTitle title="Manage Extensions - Contributor Guidelines - Development | OpenBB Platform Docs" />
 
 To install an extension hosted on PyPI, use the `pip install <extension>` command.