Skip to content

Improve blob docs - #399

Merged
bprobert97 merged 3 commits into
mainfrom
improve-blob-docs
Oct 30, 2026
Merged

bprobert97 merged 3 commits into
mainfrom
improve-blob-docs

Conversation

@rwb27

@rwb27 rwb27 commented Aug 6, 2026 •

Copy link
Copy Markdown
Collaborator

This tidies up the explanation of how blobs are structured and managed.

I experimented with sphinxcontrib-mermaid for diagrams, and have added one to the section that @julianstirling found confusing. I'm very open to improvements, but I think it's already quite helpful.

Closes #308

@barecheck

barecheck Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

Barecheck - Code coverage report

Total: 97.42%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

Comment thread docs/source/blobs.rst Resolved
Comment thread docs/source/blobs.rst Resolved
@rwb27
rwb27 force-pushed the improve-blob-docs branch from 4717808 to 6ffd276 Compare October 29, 2026 23:00
@rwb27
rwb27 requested a review from bprobert97 October 29, 2026 23:05
@rwb27

rwb27 commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator Author

@bprobert97 I've added a class diagram showing the Blob-related classes, which shows in the built docs.

@bprobert97
bprobert97 merged commit e9a62d7 into main Oct 30, 2026
14 checks passed
@bprobert97
bprobert97 deleted the improve-blob-docs branch October 30, 2026 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explain how Blob data is managed beter

2 participants