docs(ai): add OPDS system architecture reference#13026
Merged
Merged
Conversation
Covers opds.openlibrary.org service, pyopds2_openlibrary library, call flow, key files, env vars, local dev setup, and known gotchas. Registers in docs/ai/README.md Domain Knowledge Bases.
pyopds2_openlibrary extends pyopds2's DataProvider and DataProviderRecord abstractions. Both repos and their relationship were missing from the initial doc.
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
1 participant
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
Adds
docs/ai/opds/index.md— the missing contributor-facing architecture reference for Open Library's OPDS 2.0 feed system.Covers:
opds.openlibrary.org(FastAPI service) andpyopds2_openlibrary(Python library)CACHE_ENABLED=false, docker-compose naming constraint, mock pattern after httpx pool PRAlso registers the new doc in
docs/ai/README.mdDomain Knowledge Bases section.Related
Closes the onboarding debt for the OPDS domain —
docs/ai/opds/index.mdpreviously did not exist.