-
-
Notifications
You must be signed in to change notification settings - Fork 363
docs/examples #3502
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.
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
docs/examples #3502
Conversation
closes #3501 |
There was a problem hiding this 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]>
no strong preference! i took your suggestion. |
This PR changes the layout of our top-level
examples
directory to be a directory-of-directories, where each sub-directory contains code + aREADME.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.