Add user-facing documentation for registry status reports#548
Merged
Conversation
Explains PDS Keyword Search as the source of truth baseline, the comparison to the Registry API, and adds an FAQ covering node filtering, superseded flag interpretation, and how to request a data release for unreleased bundle/collection versions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
docs/status/README.md: Added a "How These Reports Work" section explaining that PDS Keyword Search is the source-of-truth baseline and the Registry API is the comparison target; added a summary table of the three report categories (missing / staged / loaded); added a FAQ covering node filtering, thesupersededflag, how to request a data release for unreleased versions, and why loaded counts exceed the baseline.docs/source/status.rst: Added a matching "How These Reports Work" section at the top of the online docs that gives the same high-level explanation and points readers to the GitHub README for the full FAQ.Test plan
docs/status/README.mdrenders correctly on GitHub (tables, links, FAQ headers)docs/source/status.rstbuilds without Sphinx warnings (tox -e docsorcd docs && make html)🤖 Generated with Claude Code