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 the Hugo documentation to be more accessible and user-friendly #1891

Merged
merged 10 commits into from
Jun 2, 2022
Merged

Improve the Hugo documentation to be more accessible and user-friendly #1891

merged 10 commits into from
Jun 2, 2022

Conversation

JerBouma
Copy link
Contributor

@JerBouma JerBouma commented Jun 2, 2022

With this change, the assumption is made people are mostly interested in the OpenBB Terminal. Therefore, when you open the documentation you are greeted with the following:

Screenshot 2022-06-02 at 17 09 30

What's good to highlight here:

  • OpenBB Terminal is automatically always expanded as it is the most relevant menu and it makes sense people see straight away what's inside.
  • The documentation you are greeted with is centered around the OpenBB Terminal but does have a few words about the other products.
  • Name change from "OpenBB Terminal" to "OpenBB Documentation" at the top. The URL remained unchanged however.
  • Renamed each menu to "OpenBB Terminal", "OpenBB Python API" and "OpenBB Bots".

I also made some minor improvements to each menu's texts and adjusted the toc shortcode to also add in a Table of Contents header.

@JerBouma JerBouma added the docs Code documentation label Jun 2, 2022
@JerBouma JerBouma merged commit f0a3dfb into OpenBB-finance:main Jun 2, 2022
@JerBouma JerBouma deleted the intro_improve branch June 2, 2022 16:14
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