chore: upgrade Docusaurus to 3.10.2 - #493
Merged
Merged
Conversation
docusaurus-plugin-openapi-docs 5 needs Docusaurus 3.10 or later, so the two move together: Docusaurus 3.5.2 -> 3.10.2 and the OpenAPI plugin and theme 4.0.1 -> 5.2.0. The API reference pages under docs/docs/gen are regenerated from the unchanged api.yaml. The diff is the plugin's new output format only: page bodies now render from per-operation JSON props (the externalJsonProps default since 4.7.1), which is where the new .json files come from. onBrokenMarkdownLinks moves under markdown.hooks, where 3.9 relocated it. The Docusaurus workflows now set up Node 24, matching the rest of CI, instead of taking whatever Node the runner image ships. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #493 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 485 485
Lines 22940 22940
=======================================
Hits 22928 22928
Misses 12 12 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
3.5.2→3.10.2(core, preset-classic, theme-mermaid)4.0.1→5.2.0. v5 requires Docusaurus ^3.10, so these move together.docs/docs/genregenerated withjust docusaurus-generate.api.yamlis unchanged, so the diff is only the plugin's new output format: pages render from per-operation JSON props (externalJsonProps, default since 4.7.1), which adds the.jsonfiles.onBrokenMarkdownLinksmoved undermarkdown.hooks(deprecated at top level in 3.9).Locally:
just docusaurus-buildsucceeds andjust docusaurus-fmt-checkpasses.Worth a look at the rendered API pages in the build preview before merging, since the page layout comes from the new plugin major.
🤖 Generated with Claude Code
https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c