chore: add a CI workflow that identifies unlinked types#3882
Merged
maxrjones merged 2 commits intozarr-developers:mainfrom Apr 8, 2026
Merged
chore: add a CI workflow that identifies unlinked types#3882maxrjones merged 2 commits intozarr-developers:mainfrom
maxrjones merged 2 commits intozarr-developers:mainfrom
Conversation
github-actions
bot
added
the
needs release notes
d-v-b
approved these changes
Apr 7, 2026
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.
This PR adds a CI check that identifies types in the rendered API docs that are not cross-referenced by mkdocstrings. The flagged types either need docs added or are internal types leaking into the public API.
TODO:
docs/user-guide/*.mdchanges/