Skip to content

docs: show package tag instead of monorepo release in subpackage docs - #4229

Open
maxrjones wants to merge 4 commits into
zarr-developers:mainfrom
maxrjones:docs/subpackage-header-version
Open

docs: show package tag instead of monorepo release in subpackage docs#4229
maxrjones wants to merge 4 commits into
zarr-developers:mainfrom
maxrjones:docs/subpackage-header-version

Conversation

@maxrjones

Copy link
Copy Markdown
Member

Summary

This PR patches mkdocs to use the subpackage's tag instead of Zarr-Python core's in the docs header.

Before After
image image

For reviewers

Opinions on whether we should duplicate the patch on each sub-package (anti-DRY) or symlink (anti-windows).

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 3, 2026
@d-v-b

d-v-b commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

this is awesome max! short term i'm leaning anti DRY (pro duplication) but longer term this is something our docs dep should handle without modifications. we should investigate upstreaming this fix

@maxrjones

Copy link
Copy Markdown
Member Author

this is awesome max! short term i'm leaning anti DRY (pro duplication) but longer term this is something our docs dep should handle without modifications. we should investigate upstreaming this fix

thanks for the prompt feedback. I consolidated both the patch script and the mkdocs configuration files.

Comment thread docs/contributing.md
Comment thread packages/zarr-indexing/uv.lock
@maxrjones
maxrjones requested a review from d-v-b August 3, 2026 19:21
Comment thread packages/source-version.js
Comment thread packages/source-version.js
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