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.

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

[DOCS] Reorganize and edit. Fix sidebar navigation #6445

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Command Coverage
sidebar_position: 4
sidebar_position: 6
description: This page details the instructions for determining the command coverage provided by the installed extensions.
keywords:
- tutorial
Expand Down
2 changes: 1 addition & 1 deletion website/content/platform/developer_guide/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The list below is intended to provide some guidance on what the general expectat
2. Documentation:
- All code contributions should come with relevant documentation, including the purpose of the contribution, how it works, and any changes it makes to existing functionalities.
- Update any existing documentation if your contribution alters the behavior of the OpenBB Platform.
- New router functions must have usage [examples](../getting_started/add_command_examples) defined.
- New router functions must have usage [examples](/platform/user_guides/add_command_examples) defined.

3. Code Quality:
- Your code should adhere strictly to the OpenBB Platform's coding standards and [conventions](architecture_overview).
Expand Down
16 changes: 1 addition & 15 deletions website/content/platform/developer_guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,4 @@ Optional extras are not included with the base installation, and these include:
- Toolkit extensions
- CLI Terminal

Refer to [Extensions](../user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.

## Topics In This Section

The pages in this section cover topics to get started using the OpenBB Platform, including:

- [Data Standardization](developer_guide/standardization)
- [Architecture Overview](developer_guide/architecture_overview)
- [OBBject](developer_guide/obbject)
- [Development](developer_guide/development)
- [Contributing](developer_guide/contributing)
- [HTTP Requests](developer_guide/http_requests)
- [Function Examples](developer_guide/function_examples)
- [Validators](explanataion/validators)
- [Tests](developer_guide/tests)
Refer to [Extensions](/platform/developer_guide/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.
2 changes: 1 addition & 1 deletion website/content/platform/getting_started/api_keys.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Authorization and API Keys
sidebar_position: 1
sidebar_position: 2
description: An overview for setting up the OpenBB Platform Python client and Fast API with data provider API keys.
keywords:
- tutorial
Expand Down
2 changes: 1 addition & 1 deletion website/content/platform/getting_started/api_requests.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: REST API Requests
sidebar_position: 5
sidebar_position: 8
description: How to send requests to the OpenBB Platform REST API.
keywords:
- tutorial
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quick Start - New Provider Extension
sidebar_position: 6
description: This page will walk through creating a new OpenBB Provider Extension from scratch. By the end, you will have the shell structure for holding models that connect to the Router through the Provider Interface.
title: Create New Provider Extension
sidebar_position: 9
description: This page will walk through creating a new OpenBB provider extension from scratch. By the end, you will have the shell structure for holding models that connect to a router through the provider interface.
keywords:
- OpenBB Platform
- Open source
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quick Start - New Router Extension
title: Create New Router Extension
sidebar_position: 8
description: This page will walk through creating a new OpenBB Router Extension from scratch. By the end, you will have the shell structure for a new router path with custom endpoints.
description: This page will walk through creating a new OpenBB Router Extension from scratch. By the end, you will have the code structure for a new router path and an api endpoint.
keywords:
- OpenBB Platform
- Open source
Expand All @@ -22,7 +22,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Quick Start - New Provider Extension - Getting Started - Development | OpenBB Platform Docs" />

This page will walk through creating a new OpenBB Provider Extension from scratch. By the end, you will have the shell structure for holding models that connect to the Router through the Provider Interface.
This page will walk through creating a new OpenBB router extension from scratch. By the end, you will have the shell structure for adding commands to the OpenBB Platform's interfaces.

## Preparation

Expand All @@ -45,7 +45,7 @@ packages = [{ include = "openbb_empty_router" }]

[tool.poetry.dependencies]
python = "^3.8,<3.12"
openbb = "^4.1.7"
openbb = "^4.2.0"

[build-system]
requires = ["poetry-core"]
Expand Down Expand Up @@ -94,7 +94,7 @@ empty = "openbb_empty_router.empty_router:router"

:::

- Insert placeholder items for the smoke test.
- Insert code for our command route.

```python
"""Empty Router"""
Expand All @@ -120,7 +120,7 @@ async def hello() -> OBBject[str]: # The output of every router command must be
return OBBject(results="Hello from the Empty Router extension!")

# This is a clone of `obb.equity.price.historical`.
# Replace this with a mapping to the Provider Interface.
# The model can be replaced with a a different model from the Provider Interface.
@router.command(
model="EquityHistorical",
)
Expand Down Expand Up @@ -192,7 +192,7 @@ The list should include the newly created and installed extension, `empty@0.0.1`

## Smoke Test

Run the placeholder commands.
Run the added commands.

```python
obb.empty.hello()
Expand All @@ -211,6 +211,6 @@ extra: {'metadata': {'arguments': {'provider_choices': {}, 'standard_params': {}

## Conclusion

This process created, built, and installed a new OpenBB Router Provider extension from scratch.
This process created, built, and installed a new OpenBB router extension from scratch.

The next step is to map Provider Interface models, and/or create custom GET/POST request functions to import directly for use in the router.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Economic Indicators
sidebar_position: 5
sidebar_position: 7
description: This page provides a tutorial for getting started using the `obb.economy.indicators` endpoint,
with the `openbb-econdb` provider extension. The command provides access to over 100 standardized indicator
symbols, covering countries around the world.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction to Financial Statements
sidebar_position: 3
sidebar_position: 5
description: This page provides an introduction to financial statement data available in the OpenBB Platform. This includes quarterly and annual reports, along with metrics and ratios by company. This guide provides examples for using the variety of sources.
keywords:
- stocks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Finding Ticker Symbols
sidebar_position: 1
sidebar_position: 3
description: This page provides comprehensive information about finding stocks in the with the OpenBB Platform. Search companies from different sources, and filter results. This guide is intended to introduce some methods for searching, screening, and discovery.
keywords:
- stocks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Loading Historical Price Data
sidebar_position: 2
sidebar_position: 4
description: This page provides an introduction to historical prices, including how to access and use them in the OpenBB Platform.
keywords:
- stocks
Expand Down
13 changes: 1 addition & 12 deletions website/content/platform/getting_started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,4 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

The pages in this section provide practical examples for getting started with the OpenBB Platform.

Topics covered include:

- [Creating a new data provider extension](how-to/quickstart_new_provider_extension)
- [Creating a new router extension](how-to/quickstart_new_router_extension)
- [Mapping the Provider Interface][(how-to/quickstart_mapping_the_provider_interface)]
- [Extending the OBBject class](how-to/add_obbject_extension)
- [Add new data to an existing endpoint](how-to/add_data_to_existing_endpoint)
- [Build a new router path](how-to/add_toolkit_extension)
- [How to make a new standard model](how-to/add_endpoint_to_existing_provider#how-to-build-a-standard-model)
- [How to Deprecate Endpoints](how-to/deprecating_endpoints)
- [How to add command examples](how-to/add_command_examples)
- [How to enable LLM Model](how-to/enable_llm_model)
Jupyter Notebook examples are also hosted in the OpenBB GitHub repository [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/examples)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quick Start - Mapping The Provider Interface
sidebar_position: 7
description: This page demonstrates how to get started mapping Provider extension models to the Provider Interface and Router. It continues with the example provided [here](quickstart_new_provider_extension). By the end, you will have mapped a new Provider extension to World News standard model.
title: Mapping New Provider
sidebar_position: 10
description: This page demonstrates how to get started mapping Provider extension models to the Provider Interface and Router. By the end, you will have mapped a new Provider extension to World News standard model.
keywords:
- OpenBB Platform
- Open source
Expand All @@ -25,7 +25,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

This page demonstrates how to get started mapping Provider extension models to the Provider Interface and Router.

It continues with the example provided [here](quickstart_new_provider_extension). By the end, you will have mapped a new Provider extension to World News standard model. This will connect it to the existing function and is accessible through the `provider` parameter.
It continues the example provided [here](create_new_provider_extension). By the end, you will have mapped a new Provider extension to the World News standard model. This will connect it to the existing command and make it accessible through the `provider` parameter.

All Provider models are made of three elements:

Expand Down Expand Up @@ -58,7 +58,7 @@ from openbb_core.provider.standard_models.world_news import WorldNewsQueryParams
from pydantic import Field
```

### Build QueryParams Model
### Create a QueryParams Model

- Create a class that inherits from the standard model.

Expand All @@ -74,7 +74,7 @@ class EmptyWorldNewsQueryParams(WorldNewsQueryParams):

Field and model validators are added here, if required.

### Build Data Model
### Create a Data Model

- Create a class that inherits from the standard model.

Expand Down Expand Up @@ -148,6 +148,7 @@ class EmptyWorldNewsFetcher(
- In the `__init__.py` where the Provider class was defined, import the Fetcher from the model file and map it to the router.

```python
# /Users/username/path_to_created_folder/empty_provider/openbb_empty_provider/__init__.py
"""Empty Provider Module."""

from openbb_empty_provider.models.world_news import EmptyWorldNewsFetcher
Expand All @@ -157,7 +158,7 @@ empty_provider = Provider(
name="empty",
website="http://empty.io",
description="""The empty provider is a supplier of promises.""",
#credentials=["api_key"],
# credentials=["api_key"],
fetcher_dict={
"WorldNews": EmptyWorldNewsFetcher
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Market Calendars
sidebar_position: 4
sidebar_position: 6
description: This page provides details on the market calendars available in the OpenBB Platform. Equity and economic calendars keep investors abreast of market activity and events. This guide provides examples for using the variety of calendars, and differences between sources.
keywords:
- stocks
Expand Down

This file was deleted.

16 changes: 8 additions & 8 deletions website/content/platform/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,33 +23,33 @@ import NewReferenceCard from "@site/src/components/General/NewReferenceCard";

The OpenBB Platform has been created and is currently maintained by the OpenBB team together with the contributions from hundreds of community members.

With its ready-to-use data connectors and a wealth of extensions, it lets you concentrate on creating outstanding financial reports and applications quickly and easily. Embrace efficiency and innovation with OpenBB!
With its ready-to-use data connectors and a wealth of extensions, it lets you concentrate on creating outstanding financial reports and applications quickly and easily.

## Documentation Structure

<ul className="grid grid-cols-1 gap-2 -ml-6">
<NewReferenceCard
title="Getting Started"
description="Goal-oriented content to help users achieve specific tasks."
description="Short goal-oriented examples to help users achieve specific tasks."
url="platform/getting_started"
/>
<NewReferenceCard
title="User Guides"
description="Learning-oriented content to help users learn how to use the OpenBB Platform."
description="In-depth learning-oriented tutorials to help users learn how to work and build with the OpenBB Platform."
url="platform/getting_started"
/>
<NewReferenceCard
title="Developer Guides"
description="Understanding-oriented content to help with developing on the OpenBB Platform."
description="In-depth explanatory articles to help developing with the OpenBB Platform."
url="platform/developer_guides"
/>
<NewReferenceCard
title="Reference"
title="Command Reference"
description="Provides detailed information about the command structure, parameters, outputs, examples, and more for the OpenBB Platform endpoints."
url="platform/reference"
/>
<NewReferenceCard
title="Data Models"
title="Data Model Reference"
description="Provides detailed information about the standard data models used in the OpenBB Platform."
url="platform/data_models"
/>
Expand All @@ -59,8 +59,8 @@ With its ready-to-use data connectors and a wealth of extensions, it lets you co
url="platform/faqs"
/>
<NewReferenceCard
title="Licesing"
title="Licensing"
description="Provides information about the licensing of the OpenBB Platform."
url="platform/data_models"
url="platform/licensing"
/>
</ul>
Loading
Loading