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) #12

Conversation

AdiSai
Copy link

@AdiSai AdiSai commented Nov 7, 2023

  • improve docs structure for V4

  • moving over changes

  • Add Docs to the navbar

  • add some, re-order sidebar

  • fix sentence

  • add docs install to source instructions

  • insert a couple of links, fix a typo

  • big terminal docs usage revamps

  • improve toggle component for tutorials

  • get rid of TOCs for all terminal docs for consistency and simplicity

  • improve platform docs

  • improve bot docs content structure

  • remove index from bot docs

  • improve ON THIS PAGE to only display TOC if at least 1 element

  • make edit this page text and icon on same line

  • add author and date to docs

  • add basic syntax page to usage

  • sidebar order for usage section

  • move api start command to the top with the import python import

  • some install page additions

  • small improvement

  • refactor routines section

  • Update introduction-to-routines.md

  • Update pipeline-of-commands.md

  • Update introduction-to-routines.md

  • Update routines-for-power-users.md

  • Update community-routines.md

  • update keyboard hotkey macros

  • askobb page

  • Update askobb-feature.md

  • Update index.md

  • Update index.md

  • Update index.md

  • Update index.md

  • fix images

  • remove HeadTitle from all files where it exist

  • get rid of extra spacing in markdown

  • small update

  • small edit

  • need index at the start because of main path when homepage of docs

  • use openAI to create SEO for front matter on my behalf

  • remove table of content from sdk page

  • finish improving metadata SEO for SDK docs

  • update duplicate header

  • update HeadTitle to be more specific on product

  • remove index from bot telegram reference

  • delete duplicated title for platform reference

  • another update

  • Hotfix/econometrics export filename fix (Hotfix/econometrics export filename fix OpenBB-finance/OpenBB#5508)

  • fix: Modify 'load' behavior to append data to existing sheet

Details:

  • Added logic to detect existing sheet and append data if present.
  • There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number.

Resolves: OpenBB-finance#5472

  • Added --export option for exporting to a desired file in /econometrics menu

  • Added a -f/--file option to provide the filename for export. Made -t/--type and -f/--file mutually exclusive.
    If -f is not given, -t is required and the filename will be generated based on the time and module.

  • Revert helper_funcs.py to original state

  • Made some arguments not required.

  • Minor changes asked by @deeleeramone

  • No sheet name

  • black


In the mobile view (media max 400px ), the text line "Installation >>" appears broken into smaller segments.

  • start PR so screenshots can get attached via GitHub website

  • Update qa.md

  • Docs/terminalpro and improvement (Docs/terminalpro and improvement OpenBB-finance/OpenBB#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


updates URL

  • Update introduction.md

add HeadTitle

  • Update ba.md

  • Update comparison.md

  • Update dark-pool-shorts.md

  • Update disc.md

  • fix docs (fix docs OpenBB-finance/OpenBB#5646)

  • Update fa.md

  • Update gov.md

  • Update ins.md

  • Update tradinghours.md

  • Delete website/content/terminal/menus/stocks/options/screener.md

  • Update Options introduction.md

  • Update screener head title

  • Update screener TOC

  • Update econometrics.md

  • Update economy head title

  • Update etf.md

  • codespell

  • Fix the redirect for intro to the correct url for docs (Fix the redirect for intro to the correct url for docs OpenBB-finance/OpenBB#5658)

  • fix the redirect for intro to the correct url for docs

  • fix code linting


  • Contributing guidelines (Contributing guidelines OpenBB-finance/OpenBB#5615)

  • intro section

  • what's expected sections

  • improve sections

  • improve sections and move how to add a data point

  • moving qa under contributor

  • better intro

  • moving the sharing section

  • better expectations

  • small intro to the contributor guidelines

  • moving things under the contributor section

  • there is no pre commits on the platform yet

  • dependency management

  • best practices for extensions

  • typo

  • collapse options subfolder

  • codespell

  • Improve Pro documentation further (Improve Pro documentation further OpenBB-finance/OpenBB#5641)

  • small improvement

  • Fix TutorialVideo for mobile view

  • main page terminal pro docs

  • jose whelp

  • placeholder index file that needs to be removed

  • fix: fixes sidebar, removes unused index.md

  • update link to api keys

  • update api keys link

  • fix hyperlinks in terminal helper

  • fix a few more links

  • fix some more links

  • linter

  • black linter

  • improve main docs page for each product

  • small refactor

  • header to take to main page of product

  • run OpenAI script to generate SEO for pro content


  • Update folders.md

  • Update integrate-your-own-backend.md

  • Update index.md

  • Update fixedincome.md

  • url

  • Update forecast.md

  • Update settings.md (Update settings.md OpenBB-finance/OpenBB#5665)

  • Update forex.md

  • fix front matter (fix front matter OpenBB-finance/OpenBB#5667)

  • Fix conflict markers that got into markdown during previous merges

  • Fix front matter list formatting

  • Fix typo

  • small thing

  • fix hyperlinks

  • Update .codespell.ignore

  • output_type options

  • Architectural considerations

  • Update sidebar to hide pro section by default

  • Minor copy changes

  • TET pattern

  • import statements

  • clarification on preferences

  • Minor copy changes

  • Lint markdown and python

  • fix: open index on collapsible root elements

  • remove old content

  • options title

  • Fix linting errors

  • Refactor sidebar label to url mapping condition


Description

  • Summary of the change / bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.
  • Make sure affected commands still run in terminal
  • Ensure the SDK still works
  • Check any related reports

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.

* improve docs structure for V4

* moving over changes

* Add Docs to the navbar

* add some, re-order sidebar

* fix sentence

* add docs install to source instructions

* insert a couple of links, fix a typo

* big terminal docs usage revamps

* improve toggle component for tutorials

* get rid of TOCs for all terminal docs for consistency and simplicity

* improve platform docs

* improve bot docs content structure

* remove index from bot docs

* improve ON THIS PAGE to only display TOC if at least 1 element

* make edit this page text and icon on same line

* add author and date to docs

* add basic syntax page to usage

* sidebar order for usage section

* move api start command to the top with the import python import

* some install page additions

* small improvement

* refactor routines section

* Update introduction-to-routines.md

* Update pipeline-of-commands.md

* Update introduction-to-routines.md

* Update routines-for-power-users.md

* Update community-routines.md

* update keyboard hotkey macros

* askobb page

* Update askobb-feature.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* fix images

* remove HeadTitle from all files where it exist

* get rid of extra spacing in markdown

* small update

* small edit

* need index at the start because of main path when homepage of docs

* use openAI to create SEO for front matter on my behalf

* remove table of content from sdk page

* finish improving metadata SEO for SDK docs

* update duplicate header

* update HeadTitle to be more specific on product

* remove index from bot telegram reference

* delete duplicated title for platform reference

* another update

* Hotfix/econometrics export filename fix (#5508)

* fix: Modify 'load' behavior to append data to existing sheet

Details:
- Added logic to detect existing sheet and append data if present.
- There is no direct way to append on the sheet, so I am reading the sheet to get the last row number and then writing after that row number.

Resolves: #5472

* Added --export option for exporting to a desired file in /econometrics menu

* Added a -f/--file option to provide the filename for export.
Made -t/--type and -f/--file mutually exclusive.
If -f is not given, -t is required and the filename will be generated based on the time and module.

* Revert `helper_funcs.py` to original state

* Made some arguments not required.

* Minor changes asked by @deeleeramone

* No sheet name

* black

---------

Co-authored-by: James Maslek <[email protected]>
Co-authored-by: Danglewood <[email protected]>

* FIX #5600 Updated the Twitter logo to X logo (#5601)

* Change Ultima paragraph (#5624)

* change ultima paragraph

* remove old paragraph

* Update CONTRIBUTING.md (#5623)

* 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 <[email protected]>

* start PR so screenshots can get attached via GitHub website

* Update qa.md

* 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 <[email protected]>
Co-authored-by: jose-donato <[email protected]>
Co-authored-by: andrewkenreich <[email protected]>

* 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

* Update crypto introduction.md

* titles

* another title

* Update crypto dd.md

* Update defi.md

* Update disc.md

* Update nft.md

* Update onchain.md

* Update ov.md

* Update introduction.md

updates URL

* Update introduction.md

add HeadTitle

* Update ba.md

* Update comparison.md

* Update dark-pool-shorts.md

* Update disc.md

* fix docs (#5646)

* Update fa.md

* Update gov.md

* Update ins.md

* Update tradinghours.md

* Delete website/content/terminal/menus/stocks/options/screener.md

* Update Options introduction.md

* Update screener head title

* Update screener TOC

* Update econometrics.md

* Update economy head title

* Update etf.md

* codespell

* Fix the redirect for intro to the correct url for docs (#5658)

* fix the redirect for intro to the correct url for docs

* fix code linting

---------

Co-authored-by: James Maslek <[email protected]>

* Contributing guidelines (#5615)

* intro section

* what's expected sections

* improve sections

* improve sections and move how to add a data point

* moving qa under contributor

* better intro

* moving the sharing section

* better expectations

* small intro to the contributor guidelines

* moving things under the contributor section

* there is no pre commits on the platform yet

* dependency management

* best practices for extensions

* typo

* collapse options subfolder

* codespell

* Improve Pro documentation further (#5641)

* small improvement

* Fix TutorialVideo for mobile view

* main page terminal pro docs

* jose whelp

* placeholder index file that needs to be removed

* fix: fixes sidebar, removes unused index.md

* update link to api keys

* update api keys link

* fix hyperlinks in terminal helper

* fix a few more links

* fix some more links

* linter

* black linter

* improve main docs page for each product

* small refactor

* header to take to main page of product

* run OpenAI script to generate SEO for pro content

---------

Co-authored-by: jose-donato <[email protected]>

* Update folders.md

* Update integrate-your-own-backend.md

* Update index.md

* Update fixedincome.md

* url

* Update forecast.md

* Update settings.md (#5665)

* Update forex.md

* fix front matter (#5667)

* Fix conflict markers that got into markdown during previous merges

* Fix front matter list formatting

* Fix typo

* small thing

* fix hyperlinks

* Update .codespell.ignore

* output_type options

* Architectural considerations

* Update sidebar to hide pro section by default

* Minor copy changes

* TET pattern

* import statements

* clarification on preferences

* Minor copy changes

* Lint markdown and python

* fix: open index on collapsible root elements

* remove old content

* options title

* Fix linting errors

* Refactor sidebar label to url mapping condition

---------

Co-authored-by: andrewkenreich <[email protected]>
Co-authored-by: Danglewood <[email protected]>
Co-authored-by: hjoaquim <[email protected]>
Co-authored-by: Sandip Saha <[email protected]>
Co-authored-by: James Maslek <[email protected]>
Co-authored-by: professssor <[email protected]>
Co-authored-by: Farookh Zaheer Siddiqui <[email protected]>
Co-authored-by: MAX SHESTOV <[email protected]>
Co-authored-by: jose-donato <[email protected]>
Co-authored-by: jose-donato <[email protected]>
Co-authored-by: Mohamad Fadil <[email protected]>
Co-authored-by: Theodore Aptekarev <[email protected]>
@AdiSai AdiSai merged commit b9a7f85 into Ultima-Insights:feature/Ultima-Platform-Integration Nov 7, 2023
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants