chore(deps): upgrade Docusaurus 2.4.3 to 3.10.x (FT-2118) - #284
Open
joalves wants to merge 7 commits into
Open
Conversation
…-openapi-docs to 5.1.3, regenerate API docs
…r needed post-mermaid-bump The resolutions block pinned cytoscape@3.23.0 and webpack@5.76.1 to work around a cytoscape export-path error under the old Docusaurus 2 / mermaid 9.4.3 toolchain. Post-upgrade, @docusaurus/core@3.10.2 requires webpack@^5.95.0, and @docusaurus/theme-mermaid@3.10.2 pulls in mermaid@11.16.1, which declares cytoscape@^3.33.3. The old pins were no longer compatible with either range and were the actual cause of the "configuration[0].plugins[6] should be one of these" webpack ValidationError seen in Task 4's build. Removing the resolutions block entirely lets yarn resolve both packages naturally: cytoscape resolves to 3.34.0 (satisfies mermaid's ^3.33.3) and webpack resolves to 5.109.2 (satisfies docusaurus core's ^5.95.0). Verified with yarn start (no cytoscape errors) and yarn build (no cytoscape or webpack ValidationError; build proceeds through MDX compilation and stops only on the 3 pre-existing MDX content issues in docs/Third-party-integrations, which are out of scope for this change).
…ader, fixes SSG ReferenceError
…x anchor typos, add redirects for renamed URLs Docusaurus 3's tightened case-sensitive broken-link checker (facebook/docusaurus#9754) surfaced that Configuration/, Events/, and Users-teams-Permissions/ (plus several files in experiments/ and a missed Teams.mdx) used mixed case while inbound links across the docs tree referenced them in lowercase. Docusaurus 2's case-insensitive matcher tolerated this silently. Renamed to match the rest of the tree's lowercase-kebab convention, updated inbound links (including src/anchorRedirects.ts's runtime anchor-redirect map), and added redirects via the repo's existing static/_redirects (Netlify) mechanism so existing bookmarked/indexed URLs don't 404 — the @docusaurus/plugin-client-redirects approach was tried first but rejected: it writes static HTML files per redirect and collides on case-insensitive filesystems for these exact mixed-case-to-lowercase renames. Also fixed pre-existing anchor bugs caught by the same tightened check: typoed self-referencing anchors in glossary.mdx (confidence-interval, false-discovery-rate-fdr, experimentation-power, type-i-error, significance-level-alpha), a stale #event-filters anchor in downloading-events.mdx, and an unregistered custom <summary> anchor in getting-started.mdx.
joalves
requested review from
bmsilva,
calthejuggler and
marcio-absmartly
as code owners
August 8, 2026 15:46
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (3)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
5 tasks
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
1 participant
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.
Summary
Upgrades the docs site from Docusaurus 2.4.3 to 3.10.2, fixing everything the bump broke:
@docusaurus/*packages,@mdx-js/react(v1→v3),prism-react-renderer(v1→v2)cytoscape/webpackresolutionspin that was fighting the newer mermaid's own requirements (this was the root cause of the long-standingyarn start/yarn buildcytoscape export error)docusaurus-plugin-openapi-docs/docusaurus-theme-openapi-docsto the v5 (PaloAltoNetworks-maintained) line, regenerated both API doc setsengines.nodefloor to>=20.0to match the installed Docusaurus 3.10.2's own requirementReferenceError: React is not definedduring static site generation — root cause was the repo's custom SWCjsLoaderwebpack override not matching Docusaurus's own default JSX transform (runtime: 'automatic')static/_redirectsmechanism so bookmarked/indexed URLs don't 404This unlocks
architecture-betamermaid diagrams for the Warehouse Native docs in a future PR (not part of this one).Ticket: FT-2118
Test plan
yarn buildpasses cleanly from a freshnode_modulesinstall (exit 0,[SUCCESS] Generated static files in "build".)yarn startdev server starts clean, no cytoscape/webpack errorsstatic/_redirects