docs: initial partial guide to progressive loading - #1109
Open
melonora wants to merge 6 commits into
Open
Conversation
kephale
reviewed
Aug 16, 2026
kephale
left a comment
Contributor
There was a problem hiding this comment.
Apply-ready concise usage guide:
Co-authored-by: Kyle I S Harrington <[email protected]>
melonora
marked this pull request as ready for review
August 17, 2026 12:06
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.
References and relevant issues
closes #1110
napari/napari#9067
Description
This PR adds a guide as to how the experimental progressive loading works in napari. @kephale added a guide particularly on how to use it and I added sections underneath explaining how it works. The latter is hopefully useful for guiding developers as they go through the code. The intial draft of the doc has now been completed.
Note that the diagrams have been created with AI, but I did go through the code base the best I possibly could to verify the implementation is in accordance with the diagrams. Here, @kephale I would like to ask you to pay close attention that this is indeed the case.