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

improve docs structure for V4 #5586

Merged
merged 128 commits into from
Nov 6, 2023
Merged
Changes from 1 commit
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
4a1dbb5
improve docs structure for V4
Oct 20, 2023
1ce74c2
moving over changes
andrewkenreich Oct 20, 2023
33993c2
Add Docs to the navbar
Oct 21, 2023
86849d3
add some, re-order sidebar
deeleeramone Oct 21, 2023
1d78b1b
fix sentence
deeleeramone Oct 21, 2023
c452c9e
add docs install to source instructions
deeleeramone Oct 21, 2023
6a99493
insert a couple of links, fix a typo
deeleeramone Oct 23, 2023
6b354db
big terminal docs usage revamps
Oct 25, 2023
cb72276
improve toggle component for tutorials
Oct 26, 2023
ed40219
get rid of TOCs for all terminal docs for consistency and simplicity
Oct 26, 2023
8667a5b
improve platform docs
Oct 26, 2023
1717e62
improve bot docs content structure
Oct 26, 2023
52c9d6e
remove index from bot docs
Oct 26, 2023
2a244a0
improve ON THIS PAGE to only display TOC if at least 1 element
Oct 26, 2023
79bae79
make edit this page text and icon on same line
Oct 26, 2023
6edec26
add author and date to docs
Oct 26, 2023
1c26463
add basic syntax page to usage
deeleeramone Oct 26, 2023
48044c3
sidebar order for usage section
deeleeramone Oct 26, 2023
7d80a4d
move api start command to the top with the import python import
deeleeramone Oct 26, 2023
d95e4a0
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
hjoaquim Oct 27, 2023
7648083
some install page additions
deeleeramone Oct 27, 2023
0c56f80
small improvement
Oct 28, 2023
c7e0cee
refactor routines section
Oct 28, 2023
93d221b
Update introduction-to-routines.md
Oct 28, 2023
f32151a
Update pipeline-of-commands.md
Oct 28, 2023
da2a737
Update introduction-to-routines.md
Oct 28, 2023
ca0fc5a
Update routines-for-power-users.md
Oct 28, 2023
d3f91dd
Update community-routines.md
Oct 28, 2023
c98dca2
update keyboard hotkey macros
Oct 28, 2023
e141624
askobb page
Oct 28, 2023
7b782fd
Update askobb-feature.md
Oct 28, 2023
69e5cb8
Update index.md
Oct 28, 2023
e97619a
Update index.md
Oct 28, 2023
3f4ea79
Update index.md
Oct 28, 2023
989f690
Update index.md
Oct 28, 2023
5806855
fix images
Oct 28, 2023
3854328
remove HeadTitle from all files where it exist
Oct 28, 2023
63df4e3
get rid of extra spacing in markdown
Oct 28, 2023
7cc8c77
small update
Oct 28, 2023
620f6ed
small edit
Oct 28, 2023
8b15d7b
need index at the start because of main path when homepage of docs
Oct 28, 2023
2498497
use openAI to create SEO for front matter on my behalf
Oct 28, 2023
f88afa4
remove table of content from sdk page
Oct 28, 2023
dcbffac
finish improving metadata SEO for SDK docs
Oct 28, 2023
4f1a26f
update duplicate header
Oct 28, 2023
bf87df3
update HeadTitle to be more specific on product
Oct 28, 2023
8938de8
remove index from bot telegram reference
Oct 28, 2023
72e7ead
delete duplicated title for platform reference
Oct 28, 2023
788a090
another update
Oct 29, 2023
195bc05
Hotfix/econometrics export filename fix (#5508)
ssahaxd Oct 30, 2023
d4b7d6e
FIX #5600 Updated the Twitter logo to X logo (#5601)
professssor Oct 30, 2023
31f0ed4
Change Ultima paragraph (#5624)
hjoaquim Oct 30, 2023
d7d8eaf
Update CONTRIBUTING.md (#5623)
FarukhS52 Oct 30, 2023
23ae1ea
mobile line-brake fixed (#5604)
maxxsh Oct 30, 2023
e380382
start PR so screenshots can get attached via GitHub website
deeleeramone Oct 30, 2023
dde1dd9
Update qa.md
deeleeramone Oct 30, 2023
4ad995f
Docs/terminalpro and improvement (#5622)
Oct 30, 2023
b9c70ec
Add light blue banner, blue when clicking sidebar + fix link in docus…
Oct 30, 2023
43fbc80
Update crypto introduction.md
deeleeramone Oct 30, 2023
e8e7828
titles
deeleeramone Oct 30, 2023
a2403ec
another title
deeleeramone Oct 30, 2023
bceed7d
Update crypto dd.md
deeleeramone Oct 31, 2023
8ac07a3
Update defi.md
deeleeramone Oct 31, 2023
46d943f
Update disc.md
deeleeramone Oct 31, 2023
b2c5ea0
Update nft.md
deeleeramone Oct 31, 2023
3028c38
Update onchain.md
deeleeramone Oct 31, 2023
c9be363
Update ov.md
deeleeramone Oct 31, 2023
99ca283
Update introduction.md
deeleeramone Oct 31, 2023
ef517f2
Update introduction.md
deeleeramone Oct 31, 2023
7ecde8e
Update ba.md
deeleeramone Oct 31, 2023
f298b91
Update comparison.md
deeleeramone Nov 1, 2023
7662548
Update dark-pool-shorts.md
deeleeramone Nov 1, 2023
485f677
Update disc.md
deeleeramone Nov 1, 2023
478fd5e
fix docs (#5646)
andrewkenreich Nov 1, 2023
31bdf13
Update fa.md
deeleeramone Nov 1, 2023
51f7a01
Update gov.md
deeleeramone Nov 1, 2023
3186202
Update ins.md
deeleeramone Nov 1, 2023
1514be0
Update tradinghours.md
deeleeramone Nov 1, 2023
9840902
Delete website/content/terminal/menus/stocks/options/screener.md
deeleeramone Nov 2, 2023
22b0083
Update Options introduction.md
deeleeramone Nov 2, 2023
99ac3dd
Update screener head title
deeleeramone Nov 2, 2023
91b16cc
Update screener TOC
deeleeramone Nov 2, 2023
654e19a
Update econometrics.md
deeleeramone Nov 2, 2023
1b468db
Update economy head title
deeleeramone Nov 2, 2023
5c47f66
Update etf.md
deeleeramone Nov 3, 2023
e305f71
codespell
deeleeramone Nov 3, 2023
1386cbb
Fix the redirect for intro to the correct url for docs (#5658)
fadilparves Nov 3, 2023
9f3fcd3
Contributing guidelines (#5615)
hjoaquim Nov 3, 2023
51b4400
Merge branch 'feature/improve-sdk-v4-docs-struct' of https://github.c…
deeleeramone Nov 3, 2023
bad7d95
collapse options subfolder
deeleeramone Nov 3, 2023
cdc416e
codespell
deeleeramone Nov 3, 2023
504a4f4
Improve Pro documentation further (#5641)
Nov 3, 2023
80efde4
Update folders.md
Nov 3, 2023
90eb092
Update integrate-your-own-backend.md
Nov 3, 2023
454bd10
Update index.md
Nov 3, 2023
e5aad53
Update fixedincome.md
deeleeramone Nov 3, 2023
8470064
url
deeleeramone Nov 3, 2023
7138cc5
Update forecast.md
deeleeramone Nov 3, 2023
c10301f
Update settings.md (#5665)
Nov 3, 2023
b825697
Update forex.md
deeleeramone Nov 3, 2023
04f0a63
fix front matter (#5667)
Nov 3, 2023
dad6ffc
Merge branch 'develop' into temp/docs
piiq Nov 5, 2023
b68cf23
Sync new doc branches with develop
piiq Nov 5, 2023
5d1f0df
Fix conflict markers that got into markdown during previous merges
piiq Nov 5, 2023
d200d9b
Fix front matter list formatting
piiq Nov 5, 2023
bd40ad9
Fix typo
piiq Nov 5, 2023
cf41ce7
small typos
Nov 5, 2023
43285b8
small thing
Nov 5, 2023
099dd53
merge with openbb-sdk-v4
Nov 5, 2023
cf37f2c
fix hyperlinks
Nov 5, 2023
4204df1
Update .codespell.ignore
Nov 5, 2023
0b83600
output_type options
hjoaquim Nov 6, 2023
8d9edb7
Architectural considerations
hjoaquim Nov 6, 2023
8dd8c37
Update sidebar to hide pro section by default
piiq Nov 6, 2023
3c5e412
Minor copy changes
piiq Nov 6, 2023
a50c440
TET pattern
hjoaquim Nov 6, 2023
cc1b5a9
import statements
hjoaquim Nov 6, 2023
732e3f5
clarification on preferences
hjoaquim Nov 6, 2023
4d26102
Merge branch 'feature/improve-sdk-v4-docs-struct' of github.com:OpenB…
hjoaquim Nov 6, 2023
34098e7
Minor copy changes
piiq Nov 6, 2023
c485396
Lint markdown and python
piiq Nov 6, 2023
8658209
fix: open index on collapsible root elements
jose-donato Nov 6, 2023
2ebcd2a
remove old content
deeleeramone Nov 6, 2023
ba0cb03
options title
deeleeramone Nov 6, 2023
9d93e0a
Fix linting errors
piiq Nov 6, 2023
528b1ec
Merge remote-tracking branch 'upstream/feature/improve-sdk-v4-docs-st…
piiq Nov 6, 2023
81a8a78
Refactor sidebar label to url mapping condition
piiq Nov 6, 2023
672a4a7
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
piiq Nov 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
Prev Previous commit
Next Next commit
use openAI to create SEO for front matter on my behalf
DidierRLopes committed Oct 28, 2023
commit 24984976e4028cccda40046ddb3d578bca433564
36 changes: 20 additions & 16 deletions website/content/bot/faqs.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
---
title: FAQs
sidebar_position: 5
description: Here we answer frequently asked questions about the OpenBB Bot from our users and community.
description: This page offers information about OpenBB Bot, covering topics such as
linking your OpenBB Bot account, trying an OpenBB Bot plan, automatic plan renewals,
refunds, access on different platforms, individual and server plans, and troubleshooting
issues with slash commands.
keywords:
[
installation,
installer,
install,
guide,
mac,
windows,
linux,
python,
github,
macos,
how to,
explanation,
openbb bot,
]
- OpenBB Bot
- OpenBB Bot account
- OpenBB plan
- billing cycle
- OpenBB Discord
- server settings
- integrations
- refunds
- subscription
- individual plan
- server plan
- slash commands
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="FAQs | OpenBB Bot Docs" />

## Generic

<details><summary>How Do I Link My OpenBB Bot Account?</summary>
35 changes: 20 additions & 15 deletions website/content/bot/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
---
title: Introduction
sidebar_position: 0
description: OpenBB Bot - a chatbot providing access to high-quality financial data
for both individual investors and online communities on Discord and Telegram. The
bot provides actionable market data, including stock data, options, screeners, crypto,
and more.
keywords:
[
getting started,
openbb,
discord,
telegram,
slack,
beginner guide,
how to use openbb bot,
introduction,
intro,
how-to,
how to,
openbb bot,
]
description: OpenBB Bot is a chatting bot for investment research that provides access to high quality financial data for both individual investors and online communities.
- OpenBB Bot
- chatting bot
- Discord
- Telegram
- financial data
- individual investors
- online communities
- stock data
- options
- screeners
- darkpool info
- crypto
- nft
- short data
- market data
- informed investors
---

# Introduction
13 changes: 11 additions & 2 deletions website/content/bot/installation/discord.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
---
title: Setting up Discord bot
sidebar_position: 2
description: How to get started with OpenBB Bot
keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,slack]
description: This page guides you on how to add a bot to your Discord server, through
steps of login, bot authorization, and adjusting bot permissions.
keywords:
- Add bot to Discord
- Discord bot setup
- Authorize Discord bot
- Bot permissions
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Setting up Discord bot - Installation | OpenBB Bot Docs" />

import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";

<AddBotDialogDiscord
22 changes: 20 additions & 2 deletions website/content/bot/installation/overview.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
---
title: Overview
sidebar_position: 1
description: How to get started with OpenBB Bot
keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram, slack]
description: Learn how to use OpenBB Bot in Discord and Telegram. Understand the requirements
for individual and server uses, and explore additional features by linking your
account. Join the community today and leverage over 1.5 Million commands executed
on OpenBB Bot.
keywords:
- OpenBB Bot
- Discord
- Telegram
- chatting applications
- link account
- user metrics
- commands
- community
- add bot
- server requirements
- individual requirements
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Overview - Installation | OpenBB Bot Docs" />

import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";

15 changes: 13 additions & 2 deletions website/content/bot/installation/telegram.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
---
title: Setting up Telegram bot
sidebar_position: 3
description: How to get started with OpenBB Bot
keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord, telegram,]
description: Step-by-step guide to add the OpenBB Bot to a Telegram group. From starting
a chat with the bot to verifying its permissions, follow these steps to have your
bot ready in your group.
keywords:
- Add bot to Telegram
- OpenBB Bot
- telegram bot setup
- telegram group
- chatbot permission
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Setting up Telegram bot - Installation | OpenBB Bot Docs" />


import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";

17 changes: 15 additions & 2 deletions website/content/bot/reference/discord/alerts/create.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: create
description: OpenBB Discord Command
description: This page provides instructions on how to use the 'create' command to
set up price alerts for specific trading symbols. It includes usage examples and
a detailed description of parameters involved such as the ticker, condition, and
price.
keywords:
- price alerts
- trading symbols
- ticker
- condition
- price
- creation command
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="create - Alerts - Discord - Reference | OpenBB Bot Docs" />

# create

This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal to or above the user defined price.
15 changes: 13 additions & 2 deletions website/content/bot/reference/discord/alerts/delete.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: delete
description: OpenBB Discord Command
description: Learn how to delete an active alert using our user-friendly commands.
This page provides detailed usage and examples of alert deletion.
keywords:
- delete
- alert
- commands
- user guide
- parameters
- usage
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="delete - Alerts - Discord - Reference | OpenBB Bot Docs" />

# delete

This command allows the user to delete an active alert they have set.
15 changes: 13 additions & 2 deletions website/content/bot/reference/discord/alerts/list.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: list
description: OpenBB Discord Command
description: The '/alerts list' command page helps users understand how to view a
list of their active alerts, including each alert's symbol, description, and threshold.
keywords:
- alerts list command
- list active alerts
- alert overview
- alerts symbols
- alerts threshold
- using alerts list
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="list - Alerts - Discord - Reference | OpenBB Bot Docs" />

# list

This command allows the user to view a list of all their active alerts. It displays each alert along with its symbol, description, and threshold, giving the user an overview of their active alerts at a glance.
15 changes: 13 additions & 2 deletions website/content/bot/reference/discord/alerts/update.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: update
description: OpenBB Discord Command
description: This page provides description and usage of the 'update' command within
the context of active alerts. It includes details on how to change the condition
of an active alert, specifically for price alerts.
keywords:
- Update command
- Price alert
- Active alerts
- Update condition
- Deactivate alert
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="update - Alerts - Discord - Reference | OpenBB Bot Docs" />

# update

This command allows the user to update the condition on an active alert, such as changing the value of a price alert. The command will update the alert with the new condition and keep the alert active until it is manually deactivated or the alert's condition is met.
16 changes: 14 additions & 2 deletions website/content/bot/reference/discord/autopost/add.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: commands add
description: OpenBB Discord Command
description: This documentation page provides in-depth insight on how to use the 'add'
command in the context of autoposting with OpenBB bot. It gives details of usage,
parameters and even provides a few illustrative examples.
keywords:
- OpenBB bot
- autopost commands
- autoposting
- commands add
- usage parameters
- automated notifications
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="commands add - Autopost - Discord - Reference | OpenBB Bot Docs" />

# commands add

This command allows the user to add an autopost command to a channel. It allows the user to receive notifications from OpenBB bot in the channel without having to manually query them. This can be used for all commands that appear in the list when you run "autopost commands add"
15 changes: 13 additions & 2 deletions website/content/bot/reference/discord/autopost/list.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: list
description: OpenBB Discord Command
description: Learn about the 'autopost list' command which allows you to view all
webhook feeds associated with a channel set up for automatic posting. Find out how
and when it can be used, with examples provided.
keywords:
- autopost list
- webhooks
- automatic posting
- channel
- command
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="list - Autopost - Discord - Reference | OpenBB Bot Docs" />

# list

This command allows users to view all webhook feeds associated with a particular channel that have been set up for automatic posting. It produces a list of all webhooks that have been configured to post content to the channel automatically, as well as information such as when they are scheduled.
19 changes: 16 additions & 3 deletions website/content/bot/reference/discord/autopost/remove.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: commands manage
description: OpenBB Discord Command
description: Documentation on how to use the 'commands manage' command for autoposts
on Discord. This includes its usage, parameters, and examples for removing or listing
feeds.
keywords:
- commands manage
- autopost command
- Discord autoposts
- manage autoposts
- remove autoposts
- autopost parameters
- autopost usage
- list autoposts
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="commands manage - Autopost - Discord - Reference | OpenBB Bot Docs" />

# commands manage

This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent.
@@ -33,4 +47,3 @@ This command allows the user to remove an autopost webhook feed from the channel
```
/autopost commands manage action:Remove
```

16 changes: 14 additions & 2 deletions website/content/bot/reference/discord/charts/c15m.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: c15m
description: OpenBB Discord Command
description: The c15m command page explains how to retrieve a 15-minute intraday chart
for any given stock ticker. This tool allows users to conduct technical analysis
and monitor short-term price fluctuations.
keywords:
- c15m command
- intraday chart
- technical analysis
- stock trading
- short-term price movements
- stock ticker
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="c15m - Charts - Discord - Reference | OpenBB Bot Docs" />

# c15m

This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements.
16 changes: 14 additions & 2 deletions website/content/bot/reference/discord/charts/c3m.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
---
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ###########
title: c3m
description: OpenBB Discord Command
description: The documentation page for /c3m command in stock market analysis tool.
This command retrieves a 3-minute intraday chart, which provides visual representation
of a stock's performance during the day, particularly useful for short-term investors.
keywords:
- 3 minute intraday chart
- stock performance
- candlestick chart
- short-term investments
- /c3m command
- trading hours
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="c3m - Charts - Discord - Reference | OpenBB Bot Docs" />

# c3m

This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors.
Loading