Commit Graph

13 Commits

Author SHA1 Message Date
Danglewood
42bf98d6a4 hotfix/options-chains-guide: Adds SDK intro guide for Options Chains (#5155)
* add SDK intro guide for options chains

* add screenshots to page
2023-06-20 12:52:52 +00:00
Danglewood
e202aeb557 Hotfix/docs-sdk-basics: Updates SDK basics page. (#5024)
* updates SDK basics guide - images to follow

* adds images

* spelling

* add sentence for token regeneration

* consolidates changing sources page with the basics page

* consolidate chart-stylying guide with basics

* api-keys pages

* adds Stocks Insiders intro to SDK docs

* typo

* add cloud installation

* syntax error

* no cloud installation instructions

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-23 20:20:29 +00:00
Danglewood
72c4ce01f3 Updates SDK Intro Guide for Fundamental Analysis Module's Recent Changes (#4964)
* Updates SDK intro guide for fundamental analysis for recent changes

* previous commit was missing this

* fixes

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-05-04 17:32:27 +00:00
northern-64bit
5e92dbe636 Fix error in the SDK portfolio intro documentation (#4945) 2023-05-01 20:41:23 +00:00
Theodore Aptekarev
18204202ac Remove stocks/disc/cnews command (#4920)
* Remove stocks/disc/cnews command from terminal and sdk

* Remove disc/cnews tests and test data

* Remove cnews from default sources, translations and intros

* Remove old test data files that are not used anymore

* Add pydocstyle ignore statement to pyproject toml

* Fix print help in stocks/disc controller test
2023-04-27 16:24:13 +00:00
Jerry Duluk
f21d25436b Improved SEO of OpenBB Docs (#4774)
* Small typo

* Updated SEO for OpenBB Bot Docs

* Updated SEO for all SDK docs pages

* Updated all SEO for OpenBB Terminal Docs pages. Plus grammar edits

* Updated spelling edits for SDK and Terminal

* fix: headtitle component

* Updated Page titles for SDK and Terminal FAQ pages

* Updated page titles for all SDK docs pages

* Updated page titles for all Terminal Docs Pages (not reference pages)

* Updated page titles for Bot (not reference pages)

* Add | OpenBB Docs title for SDK and Terminal (#4883)

* add Terminal | OpenBB Docs

* SDK | OpenBB Docs added

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2023-04-25 13:58:58 +00:00
Danglewood
af800613c8 Hotfix/docs - Some Intros Updates. (#4777)
* removes .ini from screener preset examples

* updates sdk economy intro

* Update economy intro guide screenshot

Swaps screenshot with new chart

* updates terminal stocks intro

* updates screenshots for stocks intro
2023-04-14 07:34:09 +00:00
martinb-bb
8397a990c9 URL(404) fixes for multiple locations (#4738)
* URL fixes

* docker url
2023-04-11 18:06:49 +00:00
Danglewood
8b30f1a117 Hotfix/stock screener - Stock Screener Fixes (#4674)
* stock screener fixes

* improves error message, this is a FinViz preset

* removes non-screener functions from screener menu

* ruff

* removes tests for removed non-screener functions

* updates tests

* black

* ruff

* adds s&p 500 sector presets

* updates Terminal intro guide for stock screener

* Update screener.md

Updates guide with screenshots.

* Update screener.md

spelling

* updates SDK Intro Guide for Stock Screener

* pylint disable=too-many-lines --> disable=C0302

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2023-04-08 20:19:04 +00:00
DidierRLopes
2754be2620 Improve overall docusaurus (#4675)
* Improve overall docusaurus

* update pypi on installation

* fix merge conflicts

* fix spelling

* change CRLF to LF

* improve docs installation for bot

* more changes

* few more

* fix

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-04-07 01:50:45 +00:00
James Maslek
69694332e6 Documentation push (#4501)
* hi didier

* Add files

* Add the changelogs from GH

* Api keys + cleaning up spelling + found some old refs

* spelling

* Merge branch 'feature/documentation3p0' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/documentation3p0

* updates to faq sections

* spelling

* fixing FA so it runs

* adding guides - need pics

* telegram/discord docs markdown format conversion

* fix: added new reference styles

* adding examples to discord - remove play button

* updating bot docs

* image showing on docs

Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>

* feat: added imageurl for examples

* updates Stocks SDK intro

* bot pics update

* updating rest of bot docs

* adding code for generating index and bot updates

* linting

* Downgrade scikit-learn to avoid DistanceMetric32 not being found

* add some updates to guide for auto select commands

* Add pytest-recorder to requirements.txt

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2023-03-23 17:36:47 +00:00
jose-donato
6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* feat: adds bot docs to docu

* fix: file structure

* fix: brings changelog and switch platform button

* adding available options and changing Example text

* fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component

* fix: updated readme to reflect new changes

* fix: made it so from iframe only shows relevant sidebar

* PLAY BUTTON WOOO - works on discord/charting/chart

* comment

* fix: search bar, improve search

* fix: hijacks ctrl+k from iframe, adds visit to hub link

* about

* setting up play button for all images on Discord

* Bot docs updates

* terminal/faqs

* update main page

* add changelog to terminal

* SDK refactoring

* minor reordering

* bot struct in place

* move bot faqs over

* updating bot index and installation

* add new letterings

* fix: adds new navbar

* fix: new bot images and layouts

* updating installation and flow

* black linter

* spelling

* spelling

* The best commit

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-16 16:29:57 +00:00
Jeroen Bouma
452ecd1275 Make adjustments to the guides (#4477)
* Update the website guides

* Fix wrong paths in about functionality

* Update settings and feature flags menu

* Done

* Done

* Update screen
2023-03-14 20:07:35 +00:00