Skip to content

chore: upgrade Docusaurus to 3.10.2 - #493

Merged
retr0h merged 1 commit into
mainfrom
chore/docusaurus-3.10
Sep 14, 2026
Merged

retr0h merged 1 commit into
mainfrom
chore/docusaurus-3.10

Conversation

@retr0h

@retr0h retr0h commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator
  • Docusaurus 3.5.23.10.2 (core, preset-classic, theme-mermaid)
  • docusaurus-plugin-openapi-docs and theme 4.0.15.2.0. v5 requires Docusaurus ^3.10, so these move together.
  • API reference pages under docs/docs/gen regenerated with just docusaurus-generate. api.yaml is 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 .json files.
  • onBrokenMarkdownLinks moved under markdown.hooks (deprecated at top level in 3.9).
  • Docusaurus build, deploy and lint workflows now set up Node 24, like the rest of CI, instead of the runner image's default.

Locally: just docusaurus-build succeeds and just docusaurus-fmt-check passes.

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

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
@retr0h
retr0h merged commit 397a20b into main Sep 14, 2026
11 checks passed
@codecov

codecov Bot commented Sep 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c01199...fc5db7f. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@retr0h
retr0h deleted the chore/docusaurus-3.10 branch September 14, 2026 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant