CtrlK
BlogDocsLog inGet started
Tessl Logo

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

88%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

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, concise migration skill with a strong workflow that includes backup, validation checkpoints, and feedback loops. Its main weakness is insufficient actionable detail — the MDX fixing and config update steps lack concrete before/after code examples, relying on a referenced file that isn't provided in the bundle. Adding a few inline examples of the most common transformations would significantly improve actionability.

Suggestions

Add 2-3 concrete before/after MDX examples inline (e.g., escaping `{`, converting `<http://...>` autolinks, wrapping JSX expressions) so Claude can act without needing the reference file.

Show the actual tsconfig and Prism import changes as code snippets (e.g., the old vs new import path for `prism-react-renderer`) rather than just describing them.

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 dependency JSON block and the `npx docusaurus-mdx-checker` command are concrete, but the MDX fixing step lacks executable examples of before/after transformations (e.g., how to escape `{`, how to convert GFM autolinks). The config update step mentions replacing tsconfig and updating Prism imports but doesn't show the actual code changes.

2 / 3

Workflow Clarity

The workflow is clearly sequenced with explicit validation checkpoints: pre-check with mdx-checker, re-run mdx-checker after fixes to confirm zero issues, and build verification with a fix-and-retry loop. The backup step and 'work on a clean tree' guidance add safety. The feedback loops for both MDX fixing and build testing are well-defined.

3 / 3

Progressive Disclosure

The skill references `references/breaking-changes.md` for the complete migration guide, which is good structure. However, no bundle files were provided, so we can't verify the reference exists or contains the detailed examples (MDX escaping patterns, Prism import changes, tsconfig replacement) that are missing from the main body. The single reference file is appropriate but the SKILL.md body is slightly too thin without it.

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 task (Docusaurus v2→v3 migration) with concrete actions and explicit trigger conditions. It uses third person voice throughout, includes rich natural trigger terms, and has both 'Use when' and 'Triggers on' clauses that make selection unambiguous. The description is comprehensive yet focused, making it easy for Claude to distinguish from other skills.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions: upgrade dependencies, rewrite MDX v1 syntax to v3 (with specific sub-actions like escape bare { and <, fix 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 'Use when' clause at the start and a 'Triggers on' clause at the end specifying exact scenarios.

3 / 3

Trigger Term Quality

Excellent coverage of natural terms users would say: 'Docusaurus', 'v2 to v3', 'MDX v1 to v3', 'React 18', 'breaking changes', 'dependency updates', 'Prism imports', '@docusaurus/tsconfig'. These are precisely the terms a developer would use when seeking migration help.

3 / 3

Distinctiveness Conflict Risk

Extremely specific niche — Docusaurus v2 to v3 migration is a narrow, well-defined task. The combination of Docusaurus, MDX version migration, and React 18 compatibility makes it highly unlikely to conflict with other skills.

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.

Repository
mcclowes/skills-docusaurus
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.