fix README.md badges and blockquote icon#2022
Conversation
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
There was a problem hiding this comment.
LGTM — thanks for extending the alert-syntax fix to the package READMEs too.
Extended reasoning...
Overview
Documentation-only change across three READMEs: (1) splits GitHub alert markers (> [!IMPORTANT], > [!WARNING], > [!NOTE]) onto their own line so GitHub renders styled callouts instead of plain blockquotes with literal [!TYPE] text, guarded with <!-- prettier-ignore --> so prettier doesn't re-collapse them; (2) gives the two npm version badges distinguishing labels and wraps them in links to the respective npm package pages; (3) incidental prettier reformatting of the inline code sample (indentation/trailing commas) and one long line wrap.
Prior review
On the first revision I flagged that the same broken alert syntax survived in packages/client/README.md and packages/server/README.md. The author addressed this in commit bc93a74 — both package READMEs now apply the identical two-line split with prettier-ignore guards. A repo-wide grep for ^> [!TYPE] <text> confirms no remaining instances.
Security risks
None. No executable code, configuration, workflow, or dependency is touched — only Markdown prose, badge image URLs (shields.io) and links to npmjs.com.
Level of scrutiny
Low. Cosmetic README rendering fix with zero impact on the published package contents beyond the README text itself. No changeset is needed for a docs-only change. The badge URLs and npm links are correct for the @modelcontextprotocol/server and @modelcontextprotocol/client packages.
Other factors
The code-sample reformatting in the root README is mechanical prettier output (4-space indent, dropped trailing commas) and doesn't change the example's semantics. Nothing here touches API surface, schemas, transports, or CI.
Motivation and Context
How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context