docs: add a page linking to the companion packages - #282
Open
d-v-b wants to merge 7 commits into
Open
Conversation
d-v-b
force-pushed
the
claude/zarr-issue-4246-readthedocs-533548
branch
2 times, most recently
from
August 11, 2026 16:30
8476172 to
62b4088
Compare
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
force-pushed
the
claude/zarr-issue-4246-readthedocs-533548
branch
from
August 11, 2026 16:50
62b4088 to
177eb51
Compare
…y with 5 updates (zarr-developers#4242) Bumps the python-dependencies group with 4 updates in the / directory: [fsspec](https://github.com/fsspec/filesystem_spec), [hypothesis](https://github.com/HypothesisWorks/hypothesis), [uv](https://github.com/astral-sh/uv) and [ruff](https://github.com/astral-sh/ruff). Updates `fsspec` from 2026.6.0 to 2026.7.0 - [Commits](fsspec/filesystem_spec@2026.6.0...2026.7.0) Updates `hypothesis` from 6.160.0 to 6.164.0 - [Release notes](https://github.com/HypothesisWorks/hypothesis/releases) - [Commits](HypothesisWorks/hypothesis@v6.160.0...v6.164.0) Updates `uv` from 0.11.31 to 0.12.0 - [Release notes](https://github.com/astral-sh/uv/releases) - [Changelog](https://github.com/astral-sh/uv/blob/main/CHANGELOG.md) - [Commits](astral-sh/uv@0.11.31...0.12.0) Updates `s3fs` from 2026.6.0 to 2026.7.0 - [Changelog](https://github.com/fsspec/s3fs/blob/main/release-procedure.md) - [Commits](https://github.com/fsspec/s3fs/commits/2026.7.0) Updates `ruff` from 0.15.22 to 0.16.0 - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@0.15.22...0.16.0) --- updated-dependencies: - dependency-name: fsspec dependency-version: 2026.7.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: python-dependencies - dependency-name: hypothesis dependency-version: 6.163.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: python-dependencies - dependency-name: ruff dependency-version: 0.16.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: python-dependencies - dependency-name: s3fs dependency-version: 2026.7.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: python-dependencies - dependency-name: uv dependency-version: 0.12.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: python-dependencies ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
…ithub.com/d-v-b/zarr-python into claude/zarr-issue-4246-readthedocs-533548
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
1 participant
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.
🤖 AI text below 🤖
Addresses zarr-developers#4246.
What I found first
No Read the Docs configuration change is needed — the subproject wiring is already done in the RTD dashboard, and RTD already treats the subproject paths as canonical:
The built subproject pages emit
<link rel="canonical" href="https://zarr.readthedocs.io/projects/zarr-metadata/en/latest/">.Two things about the literal ask in the issue (an index page at
/projects/):/projects/is reserved by RTD's subproject resolver; there is no listing page and no setting that adds one. The only related knob is a Business-plan feature that renames or drops the prefix, it does not populate it.zarrproject (/_/addons/?...) returnsprojects: {current, translations: []}— no subproject list, so there is nothing for the flyout to render.So this is a docs-content problem rather than a configuration one. Before this PR the only links to the companion packages were two entries at the very bottom of the ~60-entry API Reference nav, pointing at the standalone
*.readthedocs.iodomains.Changes
docs/projects.md("Related Projects"), a top-level nav entry between Examples and API Reference. It builds to/en/latest/projects/— the closest reachable equivalent of the URL in the issue, since the bare/projects/prefix is reserved.https://zarr.readthedocs.io/projects/{zarr-metadata,zarr-indexing}/, so following one keeps the reader on this site's domain and matches the canonical URL RTD already advertises.zarr-python ↪link back to the parent docs; previously they only linked back to GitHub.Verification
mkdocs build --strictpasses for all three sites (root, zarr-metadata, zarr-indexing) — the same command RTD runs.projects/, and both subproject sites carry the back-link.Not done
An RTD exact redirect
/projects/->/en/stable/projects/would make the exact URL from the issue resolve. I left it out: subproject resolution most likely runs before user redirects, so it needs testing against the live project and is not worth blocking this on.