search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
9 stars 37 forks source link

Update slicing/rendering docs #424

Closed andy-sweet closed 1 week ago

andy-sweet commented 4 weeks ago

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.

psobolewskiPhD commented 4 weeks ago

@andy-sweet This is looking outstanding! 😍

andy-sweet commented 3 weeks ago

Some more progress here. I think one more push and this should be ready for review.

andy-sweet commented 3 weeks ago

I'm marking this ready for review mostly because I've run out of steam...

I included links to docs, parts of the API, and even private implementation details (where I used permalinks to main as it exists now). I also linked to some issues. The goal was to explain some of the implementation details to help other developers and contributors.

@brisvag : I included a sub-section on thick slicing here, since it seemed like a good fit for the content. It's not super detailed, but gives a basic example of how to use it and what it means. Feel free to make suggestions there!

I think some parts of this are pretty good, but it gets pretty rough in some places. The Drawing section is especially terrible. If anyone feels like improving that, I would welcome contributions!

andy-sweet commented 3 weeks ago

Also happy to discuss this in the next documentation working group.

andy-sweet commented 1 week ago

@DragaDoncila : thanks for the review and the grammar fixes! I think I address all your comments here, but let me know if there are still issues.

andy-sweet commented 1 week ago

In that case, I'll merge this after 24 hours unless anyone objects or has other suggestions.