This repository was archived by the owner on Oct 1, 2026. It is now read-only.
V5 docs - #173
Merged
Merged
V5 docs#173
Conversation
Snapshot the pre-V5 ODP docs as version v4, add the ODP sidebar config, and add the version picker used by the desktop sidebar and mobile menu. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Generate the Python reference into content-odp from the OpenBB v5 branch in CI, without the shared asset-class routers. Handle commands named index and escape < in generated MDX. Give the llms.txt generator and search index the ODP docs plugin, fix ODP links in the mobile menu, lint content-odp, and fix the tsc errors from @types/react 19. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add the Python reference and data models generated from openbb 4.7.2 to the v4 snapshot, and point the snapshot's /odp links at v4 pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Document provider-owned namespaces, the Apache-2.0 license, openbb.toml, streaming, the openbb-api and openbb-mcp launchers, and the V5 CLI. Add the user guide and the migration guide, move the CLI REPL pages into their own section, and fold duplicated V4 pages into the V5 ones. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The openbb-bls, ecb, us-eia, finra, imf, and oecd build hooks crawl their upstream APIs and import openbb_core, which fails in uv's isolated build environment on a fresh clone. Install with HATCH_BUILD_NO_HOOKS and generate only the IMF metadata cache, which openbb-imf needs at import time, restoring it from actions/cache. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Build hatchling, requests, and openbb-core into the environment first, then run dev_install.py without build isolation so the provider build hooks can import openbb_core. Cache the generated provider metadata and pass EIA_API_KEY for the EIA catalog. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the OpenBB source checkout, dev_install.py, and the provider metadata cache with a PyPI install of openbb 5 plus the econometrics, quantitative, and technical extensions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The openbb 5.0.0 package now installs V5 from PyPI. Describe what it installs and its routers extra, drop the stale 4.7.3 warning, point the source install at develop, and list the steps a fresh clone needs for the provider metadata build hooks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
List the generated V5 reference and data model routes at startup and redirect every /odp/python, /python, and /platform reference or data model path that V5 does not have to its page under /odp/v4. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
piiq
approved these changes
Sep 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds ODP-side changes for versioning with V4 & V5. Currently, triggering the V5 generation from the V5 branch.