Repository navigation
docs: introduce both plugins with version badges - #617
Merged
Merged
Conversation
There was a problem hiding this comment.
Review:
No actionable findings.
The change is README-only and internally consistent: every reference-style link added at the top ([ship-info-badge], [ship-info-npm], [navy-staff-badge], [navy-staff-npm]) is defined exactly once, the obsolete npm-badge/npm definitions and their only usage are removed together, and no dangling references remain. The new "published" wording and the Navy Staff npm badge match the repository's own poi-plugin-navy-staff@2.0.0 release tag, and the file is treated as documentation by the changelog-intent checker (isDocumentationOrTest), so no changeset or CI coverage is required.
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
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.
The README still presented the repository as Ship Info alone and placed its only version badge at the bottom. Introduce Ship Info and Navy Staff together, put both labeled npm version badges directly below the title, and link each to its package.
Remove outdated Navy Staff placeholder and unreleased-package statements while preserving the installation and development instructions.
Validation: both badge endpoints returned HTTP 200 with the expected package labels and versions; links, whitespace, and changelog enforcement checked. Local Codex Sol review found no actionable issues. README-only change; no runtime tests run.