CtrlK
BlogDocsLog inGet started
Tessl Logo

mcclowes/docusaurus-v2-to-v3-migration

Use when migrating Docusaurus projects from v2 to v3 — upgrade @docusaurus/React/MDX/prism dependencies, rewrite MDX v1 syntax to v3 (escape bare { and <, fix autolinks), swap @tsconfig/docusaurus for @docusaurus/tsconfig, update Prism imports, and resolve React 18 breaking changes. Triggers on tasks involving MDX v1 to v3 migration, Docusaurus dependency updates, React 18 compatibility, or v2/v3 breaking changes.

72

Quality

90%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

Quality

Content

77%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

This is a well-structured migration skill with excellent workflow clarity including backup, validation checkpoints, and feedback loops. Its main weakness is the lack of concrete, executable examples for the most critical transformations (MDX escaping patterns, tsconfig replacement, Prism import changes) — these are described abstractly rather than shown. The content is admirably concise but crosses into being too sparse on the actionable details that would make it copy-paste ready.

Suggestions

Add concrete before/after examples for the most common MDX fixes (escaping `{`, escaping `<`, converting GFM autolinks) directly in the SKILL.md — even 2-3 inline examples would significantly improve actionability.

Include the actual npm upgrade command (e.g., `npm install @docusaurus/core@^3.0.0 ...`) rather than just the target dependency JSON, so the step is copy-paste executable.

Show the specific tsconfig and Prism import changes inline (e.g., old import → new import) since these are small, concrete transformations that don't warrant a separate file lookup.

DimensionReasoningScore

Conciseness

The content is lean and efficient. It doesn't explain what Docusaurus is, what MDX is, or how npm works. Every section delivers only what Claude needs to know to perform the migration. The core principles section is terse but informative.

3 / 3

Actionability

The migration steps are clear but lack executable commands for key operations (e.g., no actual npm install/upgrade commands, no concrete examples of escaping `{` or `<` in MDX files, no example of the Prism import change or tsconfig swap). The dependency JSON block is helpful but the actual transformation examples are deferred entirely to the reference file.

2 / 3

Workflow Clarity

The workflow is well-sequenced with explicit validation checkpoints: pre-check with mdx-checker, re-run mdx-checker after fixing MDX (confirming zero issues before proceeding), and build verification at the end with a fix-and-retry loop. The backup step and clean-tree advice add safety. This is a strong workflow with feedback loops for a destructive/batch migration.

3 / 3

Progressive Disclosure

The skill references `references/breaking-changes.md` for the complete guide, which is good structure. However, no bundle files were provided, so we can't verify the reference exists or is well-structured. The SKILL.md itself is appropriately concise as an overview, but having only a single reference file means all detailed content (MDX examples, config changes, Prism imports) is presumably in one monolithic file rather than being split by topic.

2 / 3

Total

10

/

12

Passed

Description

100%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

This is an excellent skill description that clearly defines a narrow, specific migration task with concrete actions and explicit trigger conditions. It uses third-person voice, lists specific technical operations, and provides both a 'what' and 'when' clause with natural trigger terms that a developer would use when needing this skill.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions: upgrade dependencies, rewrite MDX v1 syntax to v3 (with specific examples like escaping bare { and <, fixing autolinks), swap tsconfig packages, update Prism imports, and resolve React 18 breaking changes.

3 / 3

Completeness

Clearly answers both 'what' (upgrade dependencies, rewrite MDX syntax, swap tsconfig, update Prism imports, resolve React 18 changes) and 'when' with an explicit trigger clause ('Triggers on tasks involving MDX v1 to v3 migration, Docusaurus dependency updates, React 18 compatibility, or v2/v3 breaking changes').

3 / 3

Trigger Term Quality

Includes highly natural and specific keywords users would say: 'Docusaurus v2 to v3', 'MDX v1 to v3 migration', 'React 18 compatibility', 'v2/v3 breaking changes', '@docusaurus/tsconfig', 'Prism imports'. These are terms a developer would naturally use when facing this migration task.

3 / 3

Distinctiveness Conflict Risk

Extremely specific niche — Docusaurus v2 to v3 migration is a very distinct task unlikely to conflict with other skills. The combination of Docusaurus, MDX version migration, and React 18 breaking changes creates a clear, unique trigger profile.

3 / 3

Total

12

/

12

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation11 / 11 Passed

Validation for skill structure

No warnings or errors.

Reviewed

Table of Contents