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

[Feature] CLI docs #6362

Merged
merged 42 commits into from
May 14, 2024
Merged

[Feature] CLI docs #6362

merged 42 commits into from
May 14, 2024

Conversation

hjoaquim
Copy link
Contributor

@hjoaquim hjoaquim commented May 2, 2024 •
edited
Loading

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

    • As the release date for the CLI approaches, we need to have the docs ready.

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

    • Added new pages for Platform CLI docs.

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

    • TBD

  4. Testing Done:

    • Run the docs website.

  5. Reviewer Notes (optional):

    • Tried to keep the former Terminal structure and use as much as possible the guides wrote for the terminal, as the majority of things still apply - added a disclaimer saying commands and menus might differ, where apllicable.

@github-actions github-actions bot added the enhancement Enhancement label May 2, 2024
@hjoaquim hjoaquim marked this pull request as draft May 2, 2024 12:10
@hjoaquim hjoaquim requested a review from IgorWounds May 2, 2024 12:10
@hjoaquim hjoaquim requested a review from deeleeramone May 2, 2024 16:22
@hjoaquim hjoaquim added docs Code documentation cli OpenBB Platform CLI labels May 2, 2024
@hjoaquim hjoaquim marked this pull request as ready for review May 2, 2024 16:24
deeleeramone
deeleeramone requested changes May 2, 2024
View reviewed changes
Copy link
Contributor

@deeleeramone deeleeramone left a comment

Choose a reason for hiding this comment

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

Tried to keep the former Terminal structure and use as much as possible the guides wrote for the terminal

Unfortunately this is not really possible. Any example syntax that existed, screenshots, etc, will be broken, and not a reflection of reality.

@deeleeramone deeleeramone added the do not merge Label to prevent pull request merge label May 8, 2024
@deeleeramone deeleeramone removed the do not merge Label to prevent pull request merge label May 12, 2024
@deeleeramone
Copy link
Contributor

@hjoaquim, have a look through now. There aren't very many visual elements because things are likely to change fast.

@hjoaquim
Copy link
Contributor Author

@hjoaquim, have a look through now. There aren't very many visual elements because things are likely to change fast.

IMO it's more than good. Amazing, thanks a lot 🚀

@hjoaquim hjoaquim enabled auto-merge May 14, 2024 15:13
@hjoaquim hjoaquim added this pull request to the merge queue May 14, 2024
Merged via the queue into develop with commit 8d060dc May 14, 2024
9 checks passed
@hjoaquim hjoaquim deleted the feature/docs-cli branch May 14, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deeleeramone deeleeramone deeleeramone approved these changes

@IgorWounds IgorWounds IgorWounds approved these changes

Assignees
No one assigned
Labels
cli OpenBB Platform CLI docs Code documentation enhancement Enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hjoaquim @deeleeramone @IgorWounds @montezdesousa