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

Make adjustments to the guides #4477

Merged
merged 8 commits into from
Mar 14, 2023
Merged

Make adjustments to the guides #4477

merged 8 commits into from
Mar 14, 2023

Conversation

JerBouma
Copy link
Contributor

@JerBouma JerBouma commented Mar 14, 2023

This does the following:

  • We were calling basic functionality "Advanced". Instead, this is now called "Guides". This comes after the "Basics" so that if you'd follow this path you will know how to work with these guides. E.g. not introduce how to export data before introducing how to even run a command.
  • Smaller updates to the guides. The general story remains intact, just moved some things around or removed a bit of content that was no longer relevant.
  • Updated the about command so that it reflects the new path.

image

@reviewpad reviewpad bot added the feat XL Extra Large feature label Mar 14, 2023
@JerBouma
Copy link
Contributor Author

This should be the final version (for now). Please let me know if any comments then we can put this section on done. @deeleeramone @jmaslek

@codecov
Copy link

codecov bot commented Mar 14, 2023

Codecov Report

❗ No coverage uploaded for pull request base (develop@a276dc4). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop    #4477   +/-   ##
==========================================
  Coverage           ?   54.53%           
==========================================
  Files              ?      596           
  Lines              ?    53520           
  Branches           ?        0           
==========================================
  Hits               ?    29187           
  Misses             ?    24333           
  Partials           ?        0           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@deeleeramone
Copy link
Contributor

This should be the final version (for now). Please let me know if any comments then we can put this section on done. @deeleeramone @jmaslek

The #basics section needs to be cleaned out, it also has:

  • basics#importing-and-exporting-data
  • basics#expanding-the-terminal-with-api-keys

@JerBouma
Copy link
Contributor Author

Done

@deeleeramone
Copy link
Contributor

Section titles should be capitalized as a Title. Each word should be capitalized unless the word is something like, "the", "in", "a". Generally, words <= 3 letters are not capitalized in a title unless it is the first word.

Screenshot 2023-03-14 at 11 15 43 AM

@JerBouma
Copy link
Contributor Author

Section titles should be capitalized as a Title. Each word should be capitalized unless the word is something like, "the", "in", "a". Generally, words <= 3 letters are not capitalized in a title unless it is the first word.

Screenshot 2023-03-14 at 11 15 43 AM

This is not part of this, solely "Usage of the OpenBB Terminal" and "Usage of the OpenBB SDK". Please speak with Theodore about this.

@deeleeramone
Copy link
Contributor

This title does not read properly, it should be "Settings & API Keys", or "Setting API Keys"

Screenshot 2023-03-14 at 11 20 31 AM

@JerBouma
Copy link
Contributor Author

This title does not read properly, it should be "Settings & API Keys", or "Setting API Keys"

Screenshot 2023-03-14 at 11 20 31 AM

Also not part of this, falls under James. Please see the document about it.

@deeleeramone
Copy link
Contributor

This is not part of this, solely "Usage of the OpenBB Terminal" and "Usage of the OpenBB SDK". Please speak with Theodore about this.

Other sections, like "Customization" and "Changing Sources" also have this.

@JerBouma
Copy link
Contributor Author

What should it be renamed to

@deeleeramone
Copy link
Contributor

Also not part of this, falls under James. Please see the document about it.

Should be removed from "Guides" then.

@JerBouma
Copy link
Contributor Author

Speak with James.

@deeleeramone
Copy link
Contributor

What should it be renamed to

The Section Titles Need to be Capitalized as a Title

@JerBouma
Copy link
Contributor Author

Done

@deeleeramone
Copy link
Contributor

overwrite whether to automatically overwrite Excel files if prompted to (default is off).

Is this exclusive to Excel files, or is it for all exported files?

@JerBouma
Copy link
Contributor Author

Excel files

@deeleeramone
Copy link
Contributor

Last item in scope is the screenshot for: basics#explanation-of-menus

Let's update this to be current, while we're here.

@JerBouma
Copy link
Contributor Author

Done

@JerBouma JerBouma added this pull request to the merge queue Mar 14, 2023
Merged via the queue into develop with commit 452ecd1 Mar 14, 2023
jmaslek pushed a commit that referenced this pull request Apr 13, 2023
* Update the website guides

* Fix wrong paths in about functionality

* Update settings and feature flags menu

* Done

* Done

* Update screen
@piiq piiq deleted the hotfix/guides branch April 24, 2023 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat XL Extra Large feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants