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

docs/new-working-docs: New working docs branch #5768

Merged
merged 113 commits into from
Dec 1, 2023
Merged

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Nov 21, 2023

This PR is a new working branch for V4 docs. This list will update as more things come about.

Changes:

  • Move V3 example notebooks to a V3 folder
  • Update historicalPriceData for V4 and as a section under usage.
  • Add a notebook for findSymbols
  • Add notebook and usage section for financialStatements
  • Add usage section for Market Calendars.
  • Add usage section for Commitment of Traders
  • Update copperToGold for V4

To Do:

  • Update other V3 notebooks where possible.
  • More usage examples under Platform/Usage.
  • Check all URLs. (some URLs can only be checked by updating the reference/data models pages and a new build of Terminal to check about)
  • Development section clean up.
  • Sort all "Reference" items according to their Python interface path.
  • Development page for OBBject. @jmaslek
  • Development page for extending OBBject. @montezdesousa
  • Development page for Cookie Cutter and check for adjustments from breaking changes. @IgorWounds (OpenBB-finance/openbb-cookiecutter@1cb7e98)
  • Contributing page with explanations of the base classes and formatting requirements. @hjoaquim
  • Section on validators - why and where we use them and when they are required. @deeleeramone
  • Sub-section (example validator) for passing dynamic default values. @deeleeramone
  • Replace architecture diagram/flow chart. @hjoaquim
  • Revamp contributing examples to include a complete process, start-to-finish (not rely on, "go fork/install cookie cutter").
  • Development page for Tests and expand beyond auto-generation utility (known caveats and debugging tests). @IgorWounds @the-praxs

@deeleeramone deeleeramone added docs Code documentation platform OpenBB Platform v4 PRs for v4 labels Nov 21, 2023
@reviewpad reviewpad bot added the feat XL Extra Large feature label Nov 21, 2023
@CLAassistant
Copy link

CLAassistant commented Nov 21, 2023

CLA assistant check
All committers have signed the CLA.

@deeleeramone
Copy link
Contributor Author

@DidierRLopes, are we updating this image or leaving it?

image

@DidierRLopes
Copy link
Collaborator

@DidierRLopes, are we updating this image or leaving it?

image

I think it needs an update, can you ask @Meg1211 ?

@hjoaquim hjoaquim mentioned this pull request Nov 30, 2023
36 tasks
@the-praxs
Copy link
Contributor

Found some bugs on the docs website, fixing them here before this is merged!

@piiq
Copy link
Contributor

piiq commented Nov 30, 2023

Is this good?

@deeleeramone
Copy link
Contributor Author

Is this good?

We can probably update the image a bit later on, eh @DidierRLopes?

@deeleeramone
Copy link
Contributor Author

I think it needs an update, can you ask @Meg1211 ?

Replacement is in position!

@jmaslek jmaslek added this pull request to the merge queue Dec 1, 2023
Merged via the queue into develop with commit c047cfe Dec 1, 2023
16 checks passed
@piiq piiq deleted the docs/new-working-docs branch December 3, 2023 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code documentation feat XL Extra Large feature platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants