Skip to content

Commit

Permalink
Improve the Hugo documentation to be more accessible and user-friendly (
Browse files Browse the repository at this point in the history
#1891)

* Greatly improve the documentation

* Rename the website from OpenBB Terminal to OpenBB Documentation

* Adjust the menu

* Add 'Table of Contents' to the toc file

* Small improvs

* Fix broken links

* Improve more

* Small small small fix
  • Loading branch information
JerBouma authored Jun 2, 2022
1 parent b976503 commit f0a3dfb
Show file tree
Hide file tree
Showing 11 changed files with 398 additions and 400 deletions.
2 changes: 1 addition & 1 deletion website/config.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
title = "OpenBB Terminal"
title = "OpenBB Documentation"
theme = "hugo-geekdoc"

# Required to get well formatted code blocks
Expand Down
326 changes: 289 additions & 37 deletions website/content/_index.md

Large diffs are not rendered by default.

23 changes: 7 additions & 16 deletions website/content/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
---
title: OpenBB Python API
geekdocCollapseSection: true
---

{{< toc-tree >}}
The OpenBB Python API was created to enable usage of the terminal functionality in python
scripts and IPython Notebooks (Jupyter). The API wraps the functionality of the terminal in a way that the Python
commands follow the same convention as the terminal.

<img width="1356" alt="image" src="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png">


- [GST python API](#gst-python-api)
- [Python environment setup](#python-environment-setup)
- [Understanding the API functions](#understanding-the-api-functions)
- [Usage examples](#usage-examples)
- [External matplotlib axes support](#external-matplotlib-axes-support)

## GST python API
For example `stocks/load aapl` becomes `openbb.stocks.load("aapl")`.

The GST python API was created to enable usage of the terminal functionality in python
scripts and IPython Notebooks (Jupyter).
The API wraps the functionality of the terminal in a way that the python commands follow
the same convention as the terminal.
<a target="_blank" href="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png"><img width="500" alt="image" src="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png"></a>

For example `stocks/load aapl` becomes `openbb.stocks.load("aapl")`.
{{< toc >}}

---

Expand Down
38 changes: 30 additions & 8 deletions website/content/bots/_index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
---
title: OpenBB Bots
geekdocCollapseSection: true
---
The purpose of the Financial Chatting bots are to remove the need of you and your group of friends /colleagues
migrating to any chatting tool to use the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly
integrate with your already existing conversations/chats/servers.

[Our personal bet on financial bots and how they will render other finance chatting tools useless.](https://twitter.com/openbb_finance/status/1501380282884268037)
Platforms:
{{< toc-tree >}}

TL;DR: We remove the need of you and your group of friends/colleagues migrating to any chatting tool to use the the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly integrate with your already existing conversations/chats/servers.
{{< columns >}}

## Discord Bot
### Discord, Telegram, Slack and GroupMe integration

The only cross-platform financial chatting bot to accommodate for your already existing groups/chats/servers.
We will go in detail regarding the commands within [Discord Bot](/OpenBBTerminal/bots/discord/).
However, for the other chatting platforms, we will just list the main differences as
the commands are expected to be invoked in the same manner.

However, for the other chatting platforms, we will just list the main differences as the commands are expected to be invoked in the same manner.
<--->

**Supported bots:**
### Investment data should be OS agnostic

- [Telegram](/OpenBBTerminal/bots/telegram/)
- [Slack](/OpenBBTerminal/bots/slack/)
- [GroupMe](/OpenBBTerminal/bots/groupme/)
This bot will allow to access the terminal features using any type of device. From mobile phone to tablet and computer.

{{< /columns >}}

{{< columns >}}

### Use bot for your own investment research

If you don't want to engage with the bot in an open-server setting, you can message the bot directly and interact with data on a more private setting.

<--->

### Customize the bot to your needs

The bot also benefits from an MIT Open Source license, which means that you can customize it according to your needs and include proprietary features.

{{< /columns >}}
43 changes: 9 additions & 34 deletions website/content/bots/discord/_index.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,35 @@
---
geekdocCollapseSection: true
---

<!-- TABLE OF CONTENTS -->
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
<li> <a style="color:#21CD9B" href="#introduction">Introduction</a> </li>
<li> <a style="color:#21CD9B" href="#getting-started">Getting Started</a> </li>
<li> <a style="color:#21CD9B" href="#commands-groups">Commands Groups</a> </li>
<li> <a style="color:#21CD9B" href="#support">Support</a> </li>
</ol>
</details>

## Introduction

Discord Bot is an easy-to-use and interactive bot for querying stock, options, futures, indices, crypto and more. The confusion in knowing the exact command structure for each feature is no longer a problem because autocomplete guides you through it, which lets you concentrate on the things that really matter - the data.

Getting started is as easy as entering the slash key in a server where the bot is hosted, or in a DM to **GameStonksBot#4609**. It takes only minutes to learn how to use, but with a little curiosity, you can get lost for hours exploring all of the possibilities, finding boundless inspiration for new trade ideas. Browse or search the documentation for more detailed information about each feature. A text list containing the variable options unique to that feature is accessible by using: `/cmds`.

More information:

- [Here is a short demonstration of the bot in action](https://youtu.be/WxTJHUfLi1U).
- [Join our Discord to try the bot for free](https://discord.com/invite/Up2QGbMKHY)
- [Join our Discord to try the bot for free](https://openbb.co/discord)

{{< toc >}}

## Getting Started

There are several ways to get started with the bot.

_1_. Join our Discord [here](https://discord.com/invite/Up2QGbMKHY) and start interacting with the bot. This is recommended because you will be in touch with our community and will benefit from tips and tricks to get faster up-to-speed.

_2_. Interact directly with the Discord bot by messaging `GameStonksBot#4609`.

_3_. Server owners and admins can add the Discord Bot to any server by using [this invite link](https://discord.com/oauth2/authorize?client_id=927232119346962513&permissions=510500797553&scope=bot%20applications.commands).

_4_. Alternatively, one can fork the Discord bot [here](https://github.com/OpenBB-finance/OpenBBTerminal). The user is then able to modify the bot at their own discretion, and the bot can be either run locally or on a privately-hosted server. Instructions for installation through Heroku can be found [here](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/bots/README.md).
1. Join our Discord [here](https://openbb.co/discord) and start interacting with the bot. This is recommended because you will be in touch with our community and will benefit from tips and tricks to get faster up-to-speed.
2. Interact directly with the Discord bot by messaging `GameStonksBot#4609`.
3. Server owners and admins can add the Discord Bot to any server by using [this invite link](https://discord.com/oauth2/authorize?client_id=927232119346962513&permissions=510500797553&scope=bot%20applications.commands).
4. Alternatively, one can fork the Discord bot [here](https://github.com/OpenBB-finance/OpenBBTerminal). The user is then able to modify the bot at their own discretion, and the bot can be either run locally or on a privately-hosted server. Instructions for installation through Heroku can be found [here](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/bots/README.md).

## Commands Groups

- [Price](/OpenBBTerminal/bots/discord/price/)
- [Options](/OpenBBTerminal/bots/discord/options/)
- [Technical Analysis](/OpenBBTerminal/bots/discord/ta)
- [Stocks Screener](/OpenBBTerminal/bots/discord/screener/)
- [Due Diligence](/OpenBBTerminal/bots/discord/dd)
- [Dark Pool & Shorts](/OpenBBTerminal/bots/discord/dps/)
- [Government Contracts](/OpenBBTerminal/bots/discord/gov/)
- [Economy](/OpenBBTerminal/bots/discord/economy/)
- [Sector & Industry Analysis](/OpenBBTerminal/bots/discord/sia)
- [Sector & Industry Analysis](/OpenBBTerminal/bots/discord/sia)
- [Stocks Discovery](/OpenBBTerminal/bots/discord/disc)
- [Miscellaneous](/OpenBBTerminal/bots/discord/misc)
{{< toc-tree >}}

## Support

Server owners and administrators are able to generate a support request ticket, or report a bug, directly from their server using the command: `/support`.

<img src="https://user-images.githubusercontent.com/85772166/155262464-7997056d-f343-48bc-95f1-0d992b0649ec.png" width="700" />

Otherwise, join [our Discord](https://discord.com/invite/Up2QGbMKHY) and someone from the community will help you!
Otherwise, join [our Discord](https://openbb.co/discord) and someone from the community will help you!
Loading

0 comments on commit f0a3dfb

Please sign in to comment.