Skip to content

docs: add glossary#3767

Open
maxrjones wants to merge 4 commits intozarr-developers:mainfrom
maxrjones:glossary
Open

docs: add glossary#3767
maxrjones wants to merge 4 commits intozarr-developers:mainfrom
maxrjones:glossary

Conversation

@maxrjones
Copy link
Member

This PR adds a glossary to help users and developers. In particular, I wanted to make sure that the relationships between chunks and shards are clearly described in the docs.

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)

Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
@maxrjones maxrjones added the documentation Improvements to the documentation label Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants