docs: add a page linking to the companion packages - #4247
Merged
d-v-b merged 6 commits intoAug 12, 2026
Conversation
The zarr-metadata and zarr-indexing docs are already Read the Docs subprojects of zarr-python and resolve under /projects/, but nothing in the main docs pointed at them except two entries buried at the bottom of the API Reference nav, which linked to the standalone *.readthedocs.io domains rather than the /projects/ paths Read the Docs advertises as canonical. Add a top-level "Related Projects" page listing each companion package, surface it as a card on the landing page, repoint the API Reference nav entries at the canonical subproject URLs, and give each subproject a nav link back to the parent docs. The changelog fragment is named for the issue rather than the PR because the upstream PR number is not known yet; rename it to that number when this is opened upstream. Closes zarr-developers#4246 Assisted-by: ClaudeCode:claude-opus-5
d-v-b
marked this pull request as ready for review
August 11, 2026 19:34
Contributor
Author
|
@kylebarron have a look at the preview docs. does this do what you wanted? |
kylebarron
approved these changes
Aug 11, 2026
Contributor
|
I think that "Related Projects" is a poor name for this. Related means like "third party projects that touch Zarr". No, these are pieces of the main zarr project. Maybe "Subprojects" would be a better word |
Contributor
Author
yup, going with that |
…ithub.com/d-v-b/zarr-python into claude/zarr-issue-4246-readthedocs-533548
Contributor
Author
|
self-merging when tests are green. we can tweak this as needed in the future. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
this PR gives our docs a page linking to the subpackages in the repo. claude wrote this.
Here's claude's description:
The zarr-metadata and zarr-indexing docs are already Read the Docs subprojects of zarr-python and resolve under /projects/, but nothing in the main docs pointed at them except two entries buried at the bottom of the API Reference nav, which linked to the standalone *.readthedocs.io domains rather than the /projects/ paths Read the Docs advertises as canonical.
Add a top-level "Related Projects" page listing each companion package, surface it as a card on the landing page, repoint the API Reference nav entries at the canonical subproject URLs, and give each subproject a nav link back to the parent docs.
Closes #4246
Assisted-by: ClaudeCode:claude-opus-5
Summary
[Describe what this PR changes and why, in your own words.]
For reviewers
[What would you most value a second look at? What are you already confident in? For a refactor, say whether behavior is meant to be unchanged.]
Author attestation
TODO
docs/user-guide/*.mdchanges/