docs: add architecture overview to API reference - #620
Merged
msiemens merged 2 commits intoAug 10, 2026
Conversation
Owner
|
Thanks @uadhran! I really like the idea but the SVG diagram seems to have some overlapping: 
Could you fix that? I really like using Mermaid for diagrams like that, it takes care of the overlapping too. Ideally, you could commit the mermaid code along with the generated SVG |
Add a high-level class diagram and data-flow summary at the top of the API docs so contributors can understand how TinyDB's core classes relate before diving into the autodoc sections. Related: msiemens#575
Replace the hand-drawn SVG (overlapping labels) with a Mermaid-generated diagram. Commit architecture.mmd as the source of truth alongside the SVG.
Contributor
Author
|
Fixed the overlapping diagram by regenerating it from Mermaid.
Regenerate with: npx @mermaid-js/mermaid-cli -i docs/_static/architecture.mmd -o docs/_static/architecture.svg -b transparent |
uadhran
force-pushed
the
docs/api-architecture-overview
branch
from
August 10, 2026 05:33
2a65a64 to
4c66a26
Compare
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
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.
Adds a high-level architecture section at the top of the API reference so readers can understand how TinyDB's core classes relate before diving into autodoc details.
Changes
docs/api.rstcovering the three layers (core API, persistence, supporting components), typical data flow, and a link toextend.rstfor contributorsdocs/_static/architecture.svgVerification
uv run py.test -v --cov=tinydb— not run (docs-only change)sphinx-build -b html docs/ _build/html— build succeeds;architecture.svgis copied into the outputRelated: #575