[Docs] Fix Broken URLs (#6494)

* fix broken urls

* couple more

* remove poetry install openbb_platform from docs generation.

* Try it this way.
This commit is contained in:
Danglewood
2024-06-12 03:04:52 -07:00
committed by GitHub
parent cdf0befe51
commit a11489614d
8 changed files with 27 additions and 19 deletions

View File

@@ -50,10 +50,9 @@ jobs:
- name: Generate Platform Markdown
run: |
poetry install -C openbb_platform --no-interaction
poetry install -C openbb_platform --no-interaction -E all
source openbb_platform/.venv/bin/activate
pip install -U poetry
pip install toml
python openbb_platform/dev_install.py -e all
python -c "import openbb; openbb.build()"
python website/generate_platform_v4_markdown.py

View File

@@ -18,12 +18,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Configuration & Settings - | OpenBB Platform CLI Docs" />
In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only.
In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/user_guides/settings_and_environment_variables), there are settings and environment variables affecting the CLI only.
:::important
API credentials are defined in the `user_settings.json` file.
Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
Find all data providers [here](/platform/user_guides/extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
Define default data sources by following the pattern outlined [here](data-sources)
:::

View File

@@ -26,7 +26,7 @@ Many commands have multiple data sources associated with it. This page describes
:::important
API credentials are defined in the `user_settings.json` file.
Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
Find all data providers [here](/platform/user_guides/extensions/), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
:::
## Data Source In-Command

View File

@@ -25,9 +25,24 @@ The OpenBB Platform CLI is a wrapper around the [Platform](/platform), and shoul
Please refer to the [OpenBB Platform install documentation](/platform/installation) for instructions and more information.
:::info
If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components.
If the OpenBB Platform is not already installed, the `openbb-cli` package will install all available components.
:::
### Windows
The machine may need to have an installation of Visual C++ Build Tools available. Download the elements highlighted in the images below.
<details>
<summary mdxType="summary">"Microsoft Visual C++ 14.0 or greater is required"</summary>
Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then continue.
![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135)
![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3)
</details>
### Linux Requirements
Linux users will need to take additional steps prior to installation.
@@ -71,26 +86,20 @@ Welcome to OpenBB Platform CLI v1.0.0
Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code.
Next, navigate into the folder: `~/OpenBBTerminal/cli`
Next, navigate into the folder: `~/OpenBBTerminal/openbb_platform`
:::tip
The Python environment should have `toml` and `poetry` installed.
The Python environment should have `poetry` installed.
```bash
pip install toml poetry
pip install poetry
```
:::
Finally, enter:
```console
poetry install
```
Alternatively, install locally with `pip`:
```bash
pip install -e .
python dev_install.py -e --cli
```
## Installing New Modules

View File

@@ -62,4 +62,4 @@ Optional extras are not included with the base installation, and these include:
- Toolkit extensions
- CLI Terminal
Refer to [Extensions](/platform/developer_guide/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.
Refer to [Extensions](/platform/user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.

View File

@@ -24,7 +24,7 @@ import HeadTitle from "@site/src/components/General/HeadTitle.tsx";
<HeadTitle title="Build New Toolkit Extension - How-To | OpenBB Platform Docs" />
Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/developer_guide/extensions).
Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/user_guides/extensions).
## How To Create A Router Extension

View File

@@ -80,7 +80,7 @@ Provider coverage can be ascertained with the command below:
obb.coverage.providers
```
Refer to, [Data Extensions](/platform/developer_guide/extensions), for instructions on installing data provider extensions.
Refer to, [Data Extensions](/platform/user_guides/extensions), for instructions on installing data provider extensions.
## Symbol