Fix documentation badge link#9
Merged
eric-tramel merged 1 commit intomainfrom May 6, 2026
Merged
Conversation
johnnygreco
approved these changes
May 6, 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.
What
Updates the README documentation badge so it links to the published Data Designer Plugins documentation site at
https://nvidia-nemo.github.io/DataDesignerPlugins/.Why
The existing badge links to
docs/adding-a-plugin.md, which is not the published documentation URL and can send readers to a broken GitHub page. The badge text also describes the old authoring-guide-only destination instead of the broader documentation site.Usage
Readers can click the README
Documentationbadge to open the published documentation home page:How
Changed the README badge image from
docs-authoring guidetodocs-documentationand updated the link target to the GitHub Pages documentation root.Validation
make syncmake docscurl -L -I --max-time 20 https://nvidia-nemo.github.io/DataDesignerPlugins/returnedHTTP/2 200curl -L -I --max-time 20 https://img.shields.io/badge/docs-documentation-bluereturnedHTTP/2 200