[Docs] Refactor Docs Pages For Diataxis

[deeleeramone]

1. Why? (1-3 sentences or a bullet point list):

   • The Documentation was harder to navigate for people that were not used to the style of learning it was facilitating. We observed that the Diataxis framework had solutions for 4 major archetypes of learning styles which we refactored our documentation to.

2. What? (1-3 sentences or a bullet point list):

   • Changes the order and structure of the documentation to follow an OpenBB-adapted Diataxis framework.
   • Adds a few new pages.

3. Impact (1-2 sentences or a bullet point list):

   • Once merged, this will change the documentation flow and the look and feel of it.

4. Testing Done:

   • Made sure it works and that links aren't broken.
   • Still requires testing from users.

5. Reviewer Notes (optional):

   • Please try approaching this with fresh eyes and following parts of it.

[jmaslek]

When I first land on the platform page, the navbar is kind of vague:

i,e what is the dfifference between a How-To Guide and a Tutorial? Same with Explanation. I dont understand what Explanation means vs introduction or Technical Descriptions or FAQS.

[jmaslek]

Im also confused on some overlap. For example there is extensions/data extensions and extsnions/toolkit , but then there is also explanation/toolkit vs provider

[jmaslek]

I think the things not clicking for me is

• There is no quick getting started

• There is no quick development guide

If I look at pandas, numpy, pytorch, scikit-learn, react, etc they all have a quick start/getting started and a development page, whereas with this I dont see exactly where we want people to be going first.

[deeleeramone]

This section has nothing to do with development, it belongs with either Installation or Getting Started.

The Table Of Contents does not click through when the item is collapsed, this also means that any direct link to a specific section will not land as intended.

[deeleeramone]

I'm confused by this, how is Publishing to PyPI related to the User experience? This is clearly a developer guide.

[deeleeramone]

Somewhere, not sure where exactly it fits, we need a page for the 'defaults' within user_settings.json.

[deeleeramone]

There are a couple of pages with explanations of, and examples demonstrating how to use, the charting extension, but are missing in this PR.

[jmaslek]

I think these should probably move under developer guide?

[jmaslek]

Same with the bottom ones here.

Notsure if we want to maybe make a "how-to/quiickstart" type folder under developer guide for being super clear that these are where you can find how to quickly add to platform?

[jmaslek]

Also the Commitment of Traders probably up to getting started with theother usage examples?

[jmaslek]