chore: Cleanup & reorganization of Examples in Vis Docs#209
Merged
Conversation
Jarbuckle
commented
Oct 16, 2025
| <OmeZarrView res={OMEZARR_DEMO_FILESETS[3].res} screenSize={screenSize} /> | ||
| </SharedCacheProvider> | ||
| ); | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Not actually a "new" file, just changed so much and moved that Git apparently couldn't sort it out. 🤷🏽
Jarbuckle
commented
Oct 16, 2025
Jarbuckle
commented
Oct 16, 2025
Comment on lines
-291
to
-314
| /** | ||
| * HEY!!! | ||
| * this is an example React Component for rendering A single slice of an OMEZARR image in a react component | ||
| * This example is as bare-bones as possible! It is NOT the recommended way to do anything, its just trying to show | ||
| * one way of: | ||
| * 1. using our rendering utilities for OmeZarr data, specifically in a react component. Your needs for state-management, | ||
| * slicing logic, etc might all be different! | ||
| * | ||
| */ | ||
| function DataPlease() { | ||
| // load our canned data for now: | ||
| const [omezarr, setfile] = useState<OmeZarrMetadata | undefined>(undefined); | ||
| useEffect(() => { | ||
| loadMetadata(demoOptions[0].res).then((dataset) => { | ||
| setfile(dataset); | ||
| logger.info('loaded!'); | ||
| }); | ||
| }, []); | ||
| return ( | ||
| <RenderServerProvider> | ||
| <SliceView omezarr={omezarr} /> | ||
| </RenderServerProvider> | ||
| ); | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This got moved into its own example folder: minimal-example
Jarbuckle
commented
Oct 16, 2025
Contributor
Author
There was a problem hiding this comment.
It thought this was the renamed version of omezarr-via-priority-cache, but it's actually a whole new file that contains the factored-out "demo options" from all of the different demos.
froyo-np
approved these changes
Oct 16, 2025
Collaborator
froyo-np
left a comment
froyo-np
left a comment
There was a problem hiding this comment.
nice, thanks for doing this!
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.
chore: Cleanup & reorganization of Examples in Vis Docs
What
The example pages, particular those for OME-Zarrs, have had their various source files living in the same folder for a while, and represent 4 different ways of setting up OME-Zarr rendering and displaying. Consequently, it was sometimes confusing figuring out which files were related to which.
This PR aims to disentangle them from each other, as well as factor out some common features and clean them up a bit.
How
examples/omezarr:minimal-example,selectable-image-demo,priority-cache-demo, andgallery-demo-- each populated only with the files relevant to that specific demo.fetch.worker.tsto acommonsubfoldermdxfiles so that the Examples menu flowed a little more logically from top to bottomPR Checklist
main?