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.

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

Restructure docs, clarify extension points and configs, use short ids #204

Merged

Conversation

jstriebel
Copy link
Member

@jstriebel jstriebel commented Feb 13, 2023

This PR

Preview of the built docs:
https://zarr-specs--204.org.readthedocs.build/en/204/v3/core/v3.0.html

@jbms
Copy link
Contributor

jbms commented Feb 16, 2023

Note: complex numbers are now part of the main spec so we can remove that extension.

docs/v3/core/v3.0.rst Outdated Show resolved Hide resolved
@jstriebel
Copy link
Member Author

@jbms Thanks for the review! I applied your feedback, and also updated the sharding and codecs spec to the newest format. This is also necessary for the data-types, but I think those need to be partially re-written anyways, not only with the new configuration syntax. It would be great to have somebody authoring a ZEP for those. (cc @MSanKeys963, might be something to ask around for in the next community meeting?)

Also cc @joshmoore and @MSanKeys963, what do you think of the updated menu header? I could imagine to use the same headers with external links on multiple pages, to get the impression of a single coherent page. This doesn't need to be tackled in the specs first, but I thought this could be a good opportunity to play around with this idea, that's why I added it here.

@jstriebel jstriebel requested a review from jbms February 17, 2023 09:39
docs/v3/core/v3.0.rst Outdated Show resolved Hide resolved
docs/v3/core/v3.0.rst Outdated Show resolved Hide resolved
docs/v3/core/v3.0.rst Outdated Show resolved Hide resolved
jbms
jbms previously approved these changes Feb 19, 2023
Copy link
Contributor

@jbms jbms left a comment

Choose a reason for hiding this comment

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

Aside from the typos, looks good to me. We may want to iterate more, but easier if this is submitted first, I think.

@jstriebel jstriebel requested a review from jbms February 20, 2023 08:42
Copy link
Contributor

@rabernat rabernat left a comment

Choose a reason for hiding this comment

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

This looks good to me overall. Thanks for doing this! 🙌

@jstriebel jstriebel merged commit fca4d7c into zarr-developers:main Feb 21, 2023
@jstriebel jstriebel deleted the restructure-and-shord-ids branch February 21, 2023 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Why do storage transformers need "type" separate from "configuration" v3 core spec: purl urls as identifiers
3 participants