Update documentation with more detailed installation instructions, requirements and more

pyproject.toml

@@ -8,7 +8,7 @@ packages = [
     { include = "openbb_terminal" },
 ]
 include = ["terminal.py"]
-readme = "website/content/sdk/quickstart/pypi.md"
+readme = "website/pypi.md"
 homepage = "https://openbb.co"
 repository = "https://github.com/OpenBB-finance/OpenBBTerminal"
 documentation = "https://docs.openbb.co/sdk"

website/content/sdk/quickstart/troubleshooting.md → website/content/sdk/faq.md

@@ -1,6 +1,6 @@
 ---
-title: Troubleshooting
-sidebar_position: 4
+title: FAQ
+sidebar_position: 6
 keywords: [faq, questions, openbb, terminal, troubleshooting, errors, bugs, issues, problems, installation, contributors, developers, github, pip]
 ---
 Still experiencing trouble after consulting this page? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact).

website/content/sdk/guides/advanced/changing-sources.md

@@ -1,6 +1,6 @@
 ---
 title: Changing Sources
-sidebar_position: 2
+sidebar_position: 3
 description: Many commands have multiple datasources attached to it. A great example is /stocka/fa/income that allows you to select YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD. Many have a default source but you can change the default sources of each command via the sources menu.
 keywords: [source, sources, default source, datasources, api keys, api, keys, openbb sdk]
 ---

website/content/sdk/guides/advanced/data.md

@@ -1,6 +1,6 @@
 ---
 title: Importing and Exporting Data
-sidebar_position: 3
+sidebar_position: 2
 description: The OpenBBUserData folder's default location is the home of the system user account. By default this will be the following paths. Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in OpenBBUserData/portfolio/holdings.
 keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, where is data exported, market data, financial data, free, openbb sdk]
 ---

website/content/sdk/quickstart/installation.md → website/content/sdk/installation.md

@@ -4,48 +4,40 @@ sidebar_position: 2
 description: The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine.
 keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, openbb, sdk, api, pip, pypi,]
 ---
-The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine.
+The OpenBB SDK provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine. **If the OpenBB Terminal has already been installed in a virtual Python environment, no additional installations are required.**
 
-:::note NOTE
+<details><summary>Minimum Requirements</summary>
 
-- Make sure you meet all [requirements](requirements.md) before proceeding.
-- If the OpenBB Terminal has already been installed in a virtual Python environment, no additional installations are required.
+- Windows 10, 
+- Modern CPU (made in the last 5 years)
+- At least 4GB of RAM
+- At least 5GB of free storage
+- Internet connection (cable or 4G mobile)
 
-:::
+</details>
 
-## 1. System Preparation
-
-Prepare the system by installing the following items:
-
-### 1.1 Install Miniconda
-
-[Install Miniconda](https://docs.conda.io/en/latest/miniconda.html)
+Before continuing with the installation process, make sure the following software is installed:
 
+<details><summary>Miniconda</summary>
 Miniconda is a Python environment and package manager. It is required for installing certain dependencies.
 
-- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below:
-
-  - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg)
-  - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh)
-  - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh)
-  - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh)
-  - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe)
-
-    **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta`
+Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below:
 
-    **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
+- Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg)
+- Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh)
+- Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh)
+- Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh)
+- Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe)
 
-### 1.2 Install CMake
 
-**CMake is required by several Python modules.**
+**NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta`
 
-**For Windows:**
+**NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
+</details>
 
-CMake is installed as a part of Microsoft C++ Build Tools. Skip ahead to the next step.
+<details><summary>CMake (Mac and Linux only)</summary>
 
-**For MacOS:**
-
-Check if homebrew is installed by running `brew --version`
+If you have a **MacBook**, check if homebrew is installed by running `brew --version`
 
 If Homebrew is not installed, run:
 
@@ -62,20 +54,17 @@ brew install cmake
 brew install gcc
 ```
 
-**For Linux:**
+If you have a **Linux** computer, use the following script:
 
 ```bash
 sudo apt update && sudo apt upgrade
 sudo apt install -y gcc cmake
 ```
+</details>
 
-## 2. Create Python Environment
-
-The first step is to create the virtual Python environment.
+## Create Python Environment
 
-### 2.1 Confirm Conda Base
-
-When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering:
+The first step is to create the virtual Python environment. When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering:
 
 ```console
 conda env list
@@ -99,25 +88,23 @@ As of writing, the most recent version of `Conda` is, `23.1.0`. If required, upd
 conda install -c conda-forge -n base conda=23.1.0
 ```
 
-### 2.2 Create the Environment
-
 Create the environment by copying the code below into the command line:
 
 ```console
 conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry
 ```
 
-### 2.3 Activate the Environment
+## Activate the Environment
 
 After the packages from Step 2 install, activate the newly created environment by entering:
 
 ```console
 conda activate obb
 ```
 
-## 3. Install the OpenBB SDK
+## Install the OpenBB SDK
 
-### 3A. Install From PyPi
+### Install From PyPi
 
 ```bash
 pip install "openbb[all]"
@@ -135,23 +122,23 @@ The [OpenBB Terminal](https://docs.openbb.co/terminal) is part of the installati
 openbb
 ```
 
-### 3B. Install via Git Clone
+### Install via Git Clone
 
-#### 3B.1 Clone the Project
+From your code editor or command line, browse to the location the OpenBB Terminal source code should live. Make sure you have completed the previous steps.
 
-Cloning the GitHub repo will download the source code to the current working directory.
+This starts by cloning the GitHub repository. This will download the source code to the current working directory.
 
 ```console
 git clone https://github.com/OpenBB-finance/OpenBBTerminal.git
 ```
 
-#### 3B.2 CD into OpenBBTerminal
+Then, navigate to this folder. This can be done in command line or through the code editor by opening the folder.
 
 ```console
 cd OpenBBTerminal
 ```
 
-#### 3B.3 Install Remaining Packages
+There are a few packages that required to be installed. This is done through Poetry, a package manager.
 
 ```bash
 pip install qdldl==0.1.5.post3
@@ -172,28 +159,13 @@ python terminal.py
 
 ## Updating the OpenBB SDK Version
 
-Use the code below to check the version number of the OpenBB SDK.
-
-```python
-from openbb_terminal.sdk import openbb
-openbb.__version__
-```
-
-Which prints a string similar to: `'2.4.1'`
-
-### A. Updating a PyPi Installation
-
-To upgrade the OpenBB SDK to the latest version, with the `obb` Python environment active, enter:
+To upgrade the OpenBB SDK to the latest version via `pypi`, with the `obb` Python environment active, enter:
 
 ```console
 pip install -U openbb[all]
 ```
 
-### B. Updating a Git Clone Installation
-
-#### B.1 Fetch changes to the code
-
-With the `obb` Python environment activated, navigate into the root folder of the cloned project. Then, pull the changes from GitHub:
+To update the OpenBB SDK via the Git Clone method with the `obb` Python environment activated, navigate into the root folder of the cloned project. Then, pull the changes from GitHub:
 
 ```console
 git fetch
@@ -202,8 +174,6 @@ git pull
 
 **Note:** If working from a forked repo, the `git pull` command will need to be adjusted to pull from the desired branch, like `origin` or `upstream`. For example, `git pull origin main`; `git pull origin develop`
 
-#### B.2 Run Poetry Install
-
 Update any changes to the dependencies by running:
 
 ```console

website/content/sdk/reference/_category_.json

@@ -1,4 +1,4 @@
 {
-  "label": "SDK Reference",
+  "label": "Reference",
   "position": 4
 }

website/content/terminal/quickstart/troubleshooting.md → website/content/terminal/faq.md

@@ -1,6 +1,6 @@
 ---
-title: Troubleshooting
-sidebar_position: 4
+title: FAQ
+sidebar_position: 5
 keywords: [faq, questions, openbb, terminal, troubleshooting, errors, bugs, issues, problems, installation, contributors, developers, github, pip]
 ---
 Still experiencing trouble after consulting this page? Reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact).