Skip to content

docs: update readme - #4251

Merged
d-v-b merged 5 commits into
zarr-developers:mainfrom
d-v-b:refresh-readme-2
Aug 12, 2026
Merged

docs: update readme#4251
d-v-b merged 5 commits into
zarr-developers:mainfrom
d-v-b:refresh-readme-2

Conversation

@d-v-b

@d-v-b d-v-b commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR tweaks the content in the main README.md and adds links to the subpackages, as well as a link to numcodecs.

I did this by hand

Author attestation

  • I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct.

TODO

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions Bot added the needs release notes Automatically applied to PRs which haven't added release notes label Aug 12, 2026
@d-v-b
d-v-b marked this pull request as ready for review August 12, 2026 12:56

@maxrjones maxrjones left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice! These are opinionated suggestions, my approval stands with or without them.

The only must fix is that the reference for the zarr main package in the ecosystem section is wrong.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
d-v-b and others added 4 commits August 12, 2026 15:13
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
@d-v-b

d-v-b commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

Nice! These are opinionated suggestions, my approval stands with or without them.

The only must fix is that the reference for the zarr main package in the ecosystem section is wrong.

thanks, I basically accepted everything. We can revisit the index of subpackages when we start making zarr depend on them.

@d-v-b
d-v-b enabled auto-merge (squash) August 12, 2026 13:23
@d-v-b
d-v-b merged commit 579ffb5 into zarr-developers:main Aug 12, 2026
30 checks passed
@d-v-b d-v-b mentioned this pull request Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants