Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update async rendering documentation #237

Closed
andy-sweet opened this issue Sep 14, 2023 · 2 comments · Fixed by #424
Closed

Update async rendering documentation #237

andy-sweet opened this issue Sep 14, 2023 · 2 comments · Fixed by #424
Assignees
@andy-sweet
Labels
content Ideas for new or improved content priority-high
Milestone
0.5.0

Comments

@andy-sweet
Copy link
Member

📚 New content request

In napari/napari#5816 we removed the old experimental octree code (which was unmaintained and non-functional) and replaced the old async rendering with the new async slicing approach described in NAP-4.

We need to make corresponding documentation updates to reflect those changes. These are mostly in-depth explanations that are targeted more at developers and I think they should mostly stay like that for now.

The code changes are available on napari's main branch, but I don't think there is any plan to make them part of a v0.4.* release. Therefore, we should aim to make these updates for 0.5.0.

Outline

I propose the following changes and additions.

  1. Update the async rendering guide to reflect the new approach using content in NAP-4.

  2. Update the rendering guide so that it's more about basic rendering, rather than chunking and octree. Alternatively, remove this section.
@andy-sweet andy-sweet added the content Ideas for new or improved content label Sep 14, 2023
@andy-sweet andy-sweet added this to the 0.5.0 milestone Sep 14, 2023
@andy-sweet
Copy link
Member Author

Another thing to consider is the work on progressive rendering, which once done will also require similar documentation updates. I'm not sure if that work will be available in v0.5.0, so we may have to make these updates independently.

@andy-sweet andy-sweet mentioned this issue Sep 14, 2023
Merged
4 tasks
@andy-sweet andy-sweet self-assigned this May 29, 2024
@andy-sweet
Copy link
Member Author

I started this in earnest and am hoping to finish a PR for review by the end of this week.

@andy-sweet andy-sweet mentioned this issue Jun 7, 2024
Merged
andy-sweet added a commit that referenced this issue Jun 25, 2024
@andy-sweet @DragaDoncila
Update slicing/rendering docs (#424)
20b8eca 
# References and relevant issues
Closes #237 
Closes #400 

# Description
This updates the current rendering docs in napari to reflect a few
things.

1. Describe how slicing and rendering works at a very high level in
napari.
2. Remove explanations of async rendering implementations that are no
longer available on `main`.
3. Add explanations and links to NAPs/issues/PRs to implementations that
replace (2).

This is still very much a work-in-progress, so isn't worth a review yet.
But wanted to share out progress as I make it (slowly...).

Some of the old explanations include some nice context and background
material. At the time of writing, I've deleted some of these, but I am
looking for ways to integrate them back into these docs.

---------

Co-authored-by: Draga Doncila Pop <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andy-sweet andy-sweet

Labels
content Ideas for new or improved content priority-high
Projects
None yet
Milestone
0.5.0
Development

Successfully merging a pull request may close this issue.

Update slicing/rendering docs andy-sweet/napari-docs
2 participants
@andy-sweet @psobolewskiPhD