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

Initialize the Guides and fill in the Introduction to Stocks #1833

Merged
merged 5 commits into from
May 18, 2022
Merged

Initialize the Guides and fill in the Introduction to Stocks #1833

merged 5 commits into from
May 18, 2022

Conversation

JerBouma
Copy link
Contributor

@JerBouma JerBouma commented May 18, 2022

This PR represents the initialization of the Guides page. Filling all these guides will together serve as a "OpenBB Terminal for Dummies" handbook explaining in much detail how the terminal works which should be answering much of the questions we receive and confusion about certain functionality.

In each of these pages we:

  • Provide a brief overview of the menu and explain, if applicable, in detail how to use the commands within this menu
  • Provide a brief description of every sub-menu on this page and have a link to the “Introduction to …” page, e.g. “Introduction to Options”.
  • Provide one or two examples of how to use the menus functionalities on this page. This is not to explain what an analyst does or what you would do, it simply explains how to use some commands.

We keep in mind the following:

  • We take a neutral position for everything we show. We don’t say things like ‘This is a good way to’ or ‘This is the gold standard’ or anything similar. These guides are not meant for any form of financial advice, conclusions or perceptions of the market.
  • The page is formal. We don’t include any type of jokes, memes or sarcasm/rhetoric comments.
  • We do not explain any financial term but refer to a different source, e.g. Investopedia.
  • The purpose of the guide is not to educate the user about how to invest but to explain how to navigate a menu.

Please look at _introduction_to_stocks.md for an example of how we could describe a menu. Please note that this is a top level menu and sub level menus (e.g. Fundamental Analysis within Stocks) should slightly differ.

I am inviting @deeleeramone and @minhhoang1023 (see Jira) and anyone else interested in writing guides to fill these in keeping in mind the general rules and formatting that apply to each document.

@JerBouma JerBouma added the docs Code documentation label May 18, 2022
@JerBouma
Copy link
Contributor Author

@DidierRLopes Why does something completely unrelated fails?

@DidierRLopes
Copy link
Collaborator

@DidierRLopes Why does something completely unrelated fails?

Not sure tbh. But it works most of the times when you re-run

@JerBouma JerBouma merged commit ccbf194 into OpenBB-finance:main May 18, 2022
@JerBouma JerBouma deleted the guides branch May 19, 2022 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants