Skip to content

Conversation

@louveshh
Copy link

Motivation

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Jest Unit Test
  • Checked with example app

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation using yarn docs-build-api
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional context

This PR fixes the broken documentation build pipeline that was failing due to dependency version mismatches and missing packages.

Changes

1. Removed js-yaml resolution (package.json, website/package.json)

  • Why deleted: The forced resolution "js-yaml": "^4.1.1" was incompatible with gray-matter (used by Docusaurus for parsing Markdown front matter)
  • Root cause: gray-matter uses yaml.safeLoad() which was removed in js-yaml 4.x as a breaking change
  • Solution: Removed the forced resolution, allowing yarn to use the compatible js-yaml 3.x version that gray-matter expects
  • Result: Fixed "Error while parsing Markdown front matter" errors during build

2. Updated Docusaurus packages to 2.4.3 (website/package.json)

  • All @docusaurus/* packages must have the same version
  • Updated from ^2.3.0 to 2.4.3 for consistency:
    • @docusaurus/core
    • @docusaurus/plugin-client-redirects
    • @docusaurus/plugin-google-analytics
    • @docusaurus/plugin-google-gtag
    • @docusaurus/preset-classic
    • @docusaurus/theme-live-codeblock
    • @docusaurus/types
    • @docusaurus/module-type-aliases

3. Added missing dependencies (website/package.json)

  • Added tailwindcss: ^3.4.0 - required by Docusaurus 2.4.3 PostCSS
  • Added autoprefixer: ^10.4.16 - PostCSS dependency

4. Regenerated lockfiles

  • yarn.lock - root lockfile
  • website/yarn.lock - website lockfile synced with updated dependencies

Testing

Verified the fix with multiple testing approaches:

  1. GitHub Actions simulation (using act):

    act -j docs --container-architecture linux/amd64
  2. Docker container:

    docker run --rm -v "$(pwd)":/app -w /app node:22 bash -c "corepack enable && corepack prepare yarn@3.2.4 --activate && yarn install && yarn docs-build"
  3. Local build and serve:

    yarn run docs-build && cd website && npx docusaurus serve

All tests confirmed that the documentation builds successfully and can be served without errors.

Related Files

  • package.json - removed js-yaml resolution
  • website/package.json - updated docusaurus versions, added tailwindcss/autoprefixer
  • yarn.lock - regenerated
  • website/yarn.lock - regenerated

@louveshh
Copy link
Author

@theianmay

@louveshh louveshh changed the title fix(docs): fix depenedencies and yarn lock fix(docs): fix github actions docs workflow dependencies and yarn lockfiles Jan 24, 2026
@theianmay theianmay self-assigned this Jan 24, 2026
@github-project-automation github-project-automation bot moved this to In Progress 🚧 in Community Roadmap 🛣 Jan 24, 2026
@theianmay theianmay added this to the v5.0.1 milestone Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: In Progress 🚧

Development

Successfully merging this pull request may close these issues.

2 participants