Commit Graph

13 Commits

Author SHA1 Message Date
montezdesousa
00febe1942 Docs/excel examples (#5920)
* regen excel md

* add syntax + basic example

* fix example

* create json with docs map

* update docs to latest functions.json + remove tiingo

* remove space from examples

* minor fix

* remove spaces

* remove spaces

* bug fix: remove folder before generating

* fix typo

* add link to appsource

* fix

* Update templates.md

* regenerate content

* change docs colors

* fix light mode

* add back tiingo

* update functions.json

* templates go later

* remove Library from reference

* Make the excel markdown being generated at runtime

* fix reference cards having commands under menu

* remove excel/reference folder since this is built at runtime by gh-pages action

* black formatting

* improve title

* add excel to the main page

* add excel image bg

* make excel sidebar show up next to pro

* improve main page

* small fix for platform page title

* update basics page

* add tip to autocomplete

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
2024-01-08 11:53:05 +00:00
DidierRLopes
a96e52de20 Docs/pro new widgets struct (#5805)
* Improve widgets library structure

* add styling to widgets library images

* black linting

* update widgets library index generator

* update border of docs image

* shift grouping Minh suggestion

* no ruff in this file

* Update chart-from-raw-data.md

* lint

* add pro to index docs

* add workflows to docs

* dunno how to spell existent lol

* navbar logo to go to root docs

* push missing bg

* backend for terminal pro repo - Andrew suggestion

* update content slightly

* no widgets-library content should be pushed, this is generated at runtime

* add Rita's vidos + review everything
2023-11-30 00:34:27 +00:00
DidierRLopes
dd833ffbac Update Pro documentation (#5784)
* fix pro videos to latest ones

* small fix

* attempt border on pro

* Update index.md

* Update index.md

* Update charting.md

* Update homepage.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update index.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update advanced-search.md

* Update copilot.md

* pro images gradient

* update images with border

* Update news.md

* Update news.md

* add examples to platform v4 generation/ fixed data model ref titles

* fix `data_reference_cards` sort by title

* Merge branch 'docs/update-pro-videos' of https://github.com/OpenBB-finance/OpenBBTerminal into docs/update-pro-videos

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-11-24 22:23:16 +00:00
DidierRLopes
b9c70ecdf4 Add light blue banner, blue when clicking sidebar + fix link in docusaurus.config.js (#5627)
* typo

* pro docs tab coloring

* sidebar selection blue

* redirecting missing
2023-10-30 21:41:56 +00:00
DidierRLopes
4ad995fdd0 Docs/terminalpro and improvement (#5622)
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00
MAX SHESTOV
23ae1eaf31 mobile line-brake fixed (#5604)
In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments.

Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-10-30 17:55:49 +00:00
jose-donato
b9a5e4b56c fix: docs min 2023-04-17 14:25:07 +00:00
jose-donato
df1a5e4f70 fix: trying new bg color (#4583)
* fix: trying new bg color

* changes to docs from conf page

* ref for bot

* playing with ref cards - feel free to revert

* update bot references

* Update ReferenceCard.tsx

* refactor doc generation files

* Delete generate_index.py

* feat: initial algoliacrawler

* Update generate_sdk_markdown.py

* new error page

* fix: lot of bug fixes

* deleting image

* fix: improved light mode and not found page

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
2023-03-28 18:14:49 +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
jose-donato
9211a8595c Update documentation with more detailed installation instructions, requirements and more (#4382)
* fix: changed button styles

* Make Rosetta requirements more clear

* Update installation instructions

* Add seperation

* Update windows.md

* Update installation docs

* fix country choices (#4403)

* Hotfix/plotsbackend start (#4404)

* readd removed plots_backend().start() from merged PR

* Update backend.py

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

* Update helper_classes.py (#4378)

Co-authored-by: James Maslek <jmaslek11@gmail.com>

* Add improvements to the website

* Fix keys wrong redirect

* Update installation

* Update requirements

* move things around

* Restructure everything

* Details

* fix: mac issue and redirect installation

* fix: mac macos

* Remove installation .md and make it dropdown

* Update installation of SDK

* Grammar

---------

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: teh_coderer <me@tehcoderer.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-09 17:05:10 +00:00
jose-donato
37d7c870ea Adds algolia to docs (#4208)
* feat: added algolia

* fix: removed unused dependency

* fix: added lock

---------

Co-authored-by: james <jmaslek11@gmail.com>
2023-02-10 14:44:09 -05:00
andrewkenreich
6381b2ae7d Doc updates and fixes (#3609)
* fixing a url

* moving around menus

* Grammar Update

* many fixes to links and some added pics to install

* Add improvements

* fix: tabs

* Move support/feedback window to FAQ

* Forgot to save

* MVC moved around

* change installation Source -> Python

* fix: tabs

* guides to basics

* Add new README LINKS

* Change links

* Change forecasting to forecast

* fix: details

* more fixes

* Change markdown file so it is ready for pypi

Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2022-11-28 12:13:47 -05:00
jose-donato
2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00