Split provider API documentation#7
Merged
Merged
Conversation
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
docs/providers.mdinto a top-level provider catalog and shared lifecycle guidedocs/providers/<provider>.mdWhy
The previous provider page mixed registry concepts, the complete CCXT API, and three local/database APIs at one level. It was difficult to scan and would become less maintainable with every provider contribution. The new hierarchy gives each provider an independent API surface while keeping shared concepts discoverable from one catalog.
Documentation structure
docs/providers.md— catalog, shared lifecycle, common requests and errorsdocs/providers/ccxt.md— CCXT catalog, bars, trades, configuration, errorsdocs/providers/csv.md— CSV constructor, mapping, harness configuration, limitationsdocs/providers/sqlite.md— read-only SQLite reflection/query APIdocs/providers/sqlalchemy.md— SQLAlchemy reflection, URL and engine configurationdocs/providers/tabular-schema.md— shared schema discovery and normalization contractValidation
ruff format --check src testsruff check .mypy srcpytest— 86 passed, 2 expected Docker-gated skipspython -m build