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.

Sign up for GitHub

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

Jump to bottom

[Docs] diataxis refactor refactor #6425

Merged
merged 4 commits into from
May 21, 2024
Merged

[Docs] diataxis refactor refactor #6425

merged 4 commits into from
May 21, 2024

Conversation

IgorWounds
Copy link
Contributor

@IgorWounds IgorWounds commented May 16, 2024 •
edited

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

    • The goal is to make the OpenBB Platform easier to navigate and less verbose. User content should go on top of most categories while developer-focused content should be at the bottom.

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

    • Converts files from markdown to mdx.
    • Renames and splits files.
    • Adds sections to reduce cognitive load.
    • Cuts some verbosity.
    • Changes the ordering and location of files.

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

    • Will drastically change the feel and look of the documentation.

  4. Testing Done:

    • Ensured it launches without issues and that the pages look and act well.

@IgorWounds IgorWounds added the docs Code documentation label May 16, 2024
@IgorWounds IgorWounds added do not merge Label to prevent pull request merge platform OpenBB Platform labels May 16, 2024
@IgorWounds IgorWounds changed the base branch from develop to docs/diataxis-refactor May 19, 2024 17:58
@IgorWounds IgorWounds removed the do not merge Label to prevent pull request merge label May 19, 2024
@github-actions github-actions bot added the v4 PRs for v4 label May 19, 2024
@deeleeramone
Copy link
Contributor

A few cents to chime in with:

  • REST API should go with Getting Started.
  • Developer-related stuff under User Guides should go with the Developer stuff.
  • Documentation - development should be included in "install from source."
  • Enable LLM Mode should be under Getting Started (IMO) - this concept dovetails with "User Settings".

@piiq @IgorWounds
[DOCS] Reorganize and edit. Fix sidebar navigation (#6445)
41440bf 
* Reorganize and edit. Fix sidebar navigation

* Fix broken linkages

* Edit

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
@IgorWounds IgorWounds marked this pull request as ready for review May 21, 2024 13:31
piiq
piiq approved these changes May 21, 2024
View reviewed changes
Copy link
Contributor

@piiq piiq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we merge this into the original PR to continue editing and review?

@IgorWounds IgorWounds merged commit f480276 into docs/diataxis-refactor May 21, 2024
5 of 7 checks passed
@IgorWounds IgorWounds deleted the docs/diataxis-refactor-refactor branch May 21, 2024 14:14
github-merge-queue bot pushed a commit that referenced this pull request May 22, 2024
@deeleeramone @IgorWounds
@jmaslek @piiq @hjoaquim
[Docs] Refactor Docs Pages For Diataxis (#6315)
3a8a71d 
* This change creates a PR

* start moving stuff around

* data_models/_category_.json

* reference/_category_.json

* moving some stuff around

* Introduction

* Documentation updates

* few broken links, clean up sidebar titles for how-to

* codespell

* quickstart - new provider extension

* add a comment

* map provider interface

* quickstart for new router extension

* [Docs] diataxis refactor refactor (#6425)

* Start refactor

* Edits

* [DOCS] Reorganize and edit. Fix sidebar navigation (#6445)

* Reorganize and edit. Fix sidebar navigation

* Fix broken linkages

* Edit

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>

* Fix links

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* Fix broken links

* Reword CLA part in the Licensing FAQ

* change titles and order suggestion - cc @IgorWounds @piiq

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@piiq piiq piiq approved these changes

@deeleeramone deeleeramone Awaiting requested review from deeleeramone

Assignees
No one assigned
Labels
docs Code documentation platform OpenBB Platform v4 PRs for v4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@IgorWounds @deeleeramone @piiq