Skip to content

Conversation

d-v-b
Copy link
Contributor

@d-v-b d-v-b commented Oct 2, 2025

This PR changes the layout of our top-level examples directory to be a directory-of-directories, where each sub-directory contains code + a README.md, which will make browsing these examples on github friendlier.

I also add a page to the user guide called examples that references the source code + readmes for the different examples. Right now we only have 1 example, but I would like to eventually add more, e.g. to demonstrate running benchmarks or integrating zarr with other tools, like visualization tooling.

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Oct 2, 2025
@d-v-b d-v-b requested a review from a team October 2, 2025 11:42
@d-v-b
Copy link
Contributor Author

d-v-b commented Oct 2, 2025

closes #3501

@github-actions github-actions bot removed the needs release notes Automatically applied to PRs which haven't added release notes label Oct 2, 2025
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these would be easier to find if the examples are separate from user-guide, rather than nested, but support merging if you have a strong preference for the current layout

Co-authored-by: Max Jones <[email protected]>
@d-v-b
Copy link
Contributor Author

d-v-b commented Oct 2, 2025

I think these would be easier to find if the examples are separate from user-guide, rather than nested, but support merging if you have a strong preference for the current layout

no strong preference! i took your suggestion.

@d-v-b d-v-b merged commit dc5334e into zarr-developers:main Oct 3, 2025
31 checks passed
@d-v-b d-v-b deleted the docs/examples branch October 3, 2025 15:44
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.

2 participants