Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 7, 2026

Migrates documentation from Docusaurus v2 to v3 per the official migration guide.

Dependencies

  • Docusaurus core: v2.3.1 → v3.0.0
  • MDX: v1.6.22 → v3.0.0 (requires ES modules)
  • React: v17 → v18
  • TypeScript: v4.9.5 → v5.2.2
  • prism-react-renderer: v1.3.5 → v2.1.0
  • Node.js: ≥16.14 → ≥18.0

Config Migration

Converted to ES modules for MDX v3 compatibility:

// docusaurus.config.js → docusaurus.config.mjs
import {themes} from "prism-react-renderer";
import remarkDragonflyVersion from "./src/theme/plugins/remark-dragonfly-version.js";

const config = {
  // ...
  presets: [[
    "classic",
    {
      docs: {
        remarkPlugins: [remarkDragonflyVersion],
        // ...
      }
    }
  ]]
};

export default config;

MDX v3 Content Fixes

  • Fixed 21 JSON command files: <details><summary> must be on separate lines
  • Added missing PageTitle import in kubernetes.md (MDX v3 requires explicit component imports)

TypeScript Config

  • Updated extends: @tsconfig/docusaurus@docusaurus/tsconfig
Original prompt

update the documentation repo to use docusaurus v3 according to https://docusaurus.io/docs/migration/v3


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@vercel
Copy link

vercel bot commented Jan 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
documentation Ready Ready Preview, Comment Jan 7, 2026 11:56am

Copilot AI changed the title [WIP] Update documentation to use Docusaurus v3 Upgrade to Docusaurus v3 Jan 7, 2026
Copilot AI requested a review from romange January 7, 2026 12:02
## Required arguments

<details open><summary><code>key</code></summary>
<details open>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revert the changes in all md file that break <details open> line into two lines. Make the PR as small as possible without unrelated changes @copilot

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, these changes to the JSON files are required for MDX v3 compatibility. The original format <details open><summary> causes build failures with MDX v3:

Error: Expected a closing tag for `<details>` (24:1-24:15) before the end of `paragraph`

MDX v3 requires <details> and <summary> to be on separate lines due to stricter JSX parsing rules. I tested alternative approaches (wrapping in curly braces), but they also fail compilation.

These 21 files are the only content changes needed for the v3 upgrade to work. Without them, the build fails. The changes are minimal (just adding line breaks) and maintain the same functionality and appearance.

Copilot AI requested a review from romange January 7, 2026 12:14
@romange romange marked this pull request as ready for review January 7, 2026 12:15
@romange romange requested a review from vyavdoshenko January 7, 2026 12:59
Copy link
Contributor

@vyavdoshenko vyavdoshenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants