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] Cleanup README Files #6156

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

[Docs] Cleanup README Files #6156

wants to merge 9 commits into from

Conversation

deeleeramone
Copy link
Contributor

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

    • Manually maintaining individual README files is prone to error and being out-of-sync.

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

    • Refer to the documentation website so we can maintain a single source of truth.

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

    • We may need to find a better way to generate the content that is visible on PyPI.

  4. Testing Done:

    • N/A

@deeleeramone deeleeramone added docs Code documentation platform OpenBB Platform v4 PRs for v4 labels Mar 1, 2024
hjoaquim
hjoaquim approved these changes Mar 7, 2024
View reviewed changes
Copy link
Contributor

@hjoaquim hjoaquim left a comment •
edited

Choose a reason for hiding this comment

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

100% agreed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoaquim hjoaquim hjoaquim approved these changes

@jmaslek jmaslek Awaiting requested review from jmaslek

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
4 participants
@deeleeramone @hjoaquim @jmaslek @IgorWounds