Skip to content

Conversation

@SwaroopH
Copy link
Member

@SwaroopH SwaroopH commented Jul 30, 2025

Overview

This PR updates the Docusaurus documentation framework to the latest version (3.8.1) and enables experimental performance features for faster builds.

Changes

🚀 Docusaurus Version Update

  • Updated Docusaurus core from 3.7.0 to 3.8.1
  • Updated all Docusaurus-related packages to maintain version consistency
  • Added @docusaurus/faster package for performance improvements

⚡ Performance Enhancements

  • Enabled experimental faster build features:
    • ssgWorkerThreads: Parallel processing for static site generation
    • rspackBundler: Faster bundler alternative to webpack
    • rspackPersistentCache: Persistent caching for improved rebuild times
  • Enabled v4 future compatibility flag for cleaner HTML output

🧹 Dependency Cleanup

  • Removed deprecated docusaurus-theme-github-codeblock theme
  • Removed legacy docusaurus v1 package
  • Updated docusaurus-theme-search-typesense from 0.15.0-0 to 0.25.0
  • Significantly reduced yarn.lock file size (5,502 lines removed)

📦 Package Changes

  • Added: @docusaurus/faster (^3.8.1)
  • Updated: All @docusaurus/* packages to 3.8.1
  • Removed:
    • docusaurus (v1.14.7)
    • docusaurus-theme-github-codeblock (^1.1.4)

Benefits

  • Faster builds: Rspack bundler and worker threads significantly reduce build times
  • Better caching: Persistent cache improves incremental build performance
  • Cleaner codebase: Removed deprecated and unused dependencies
  • Future-proof: Enabled v4 compatibility flags for smoother future migrations

Testing

  • Local development server starts successfully
  • Production build completes without errors
  • All documentation pages render correctly
  • Search functionality works as expected
  • No visual regressions in the UI

Breaking Changes

None expected. The removed GitHub codeblock theme was not actively used in the documentation.

SwaroopH added 3 commits July 29, 2025 19:12
…ependency upgrades

- Renamed project from "docs" to "powerloom-docs" and updated version to "1.0.0".
- Added license, author, homepage, bugs, and repository information to package.json.
- Upgraded Docusaurus dependencies to version 3.8.1.
- Updated various dependencies in yarn.lock to their latest versions, including @csstools packages and postcss-related packages.
…ce improvements

- Added future configuration options in docusaurus.config.js to enable experimental features for faster builds.
- Included the @docusaurus/faster package in package.json to leverage enhanced performance capabilities.
- Updated yarn.lock to reflect new dependencies and their versions for improved build efficiency.
- Removed the 'docusaurus-theme-github-codeblock' from docusaurus.config.js as it is no longer needed.
- Updated package.json to upgrade React and other dependencies to their latest versions for improved performance and compatibility.
- Updated yarn.lock to reflect the changes in package versions and added new dependencies for enhanced functionality.
@SwaroopH SwaroopH self-assigned this Jul 30, 2025
SwaroopH added 5 commits July 29, 2025 20:52
- Updated the Node.js version matrix to include 20.x and 22.x.
- Upgraded actions/checkout from v3 to v4.
- Upgraded actions/setup-node from v3 to v4 and changed cache from 'npm' to 'yarn'.
- Expanded the introduction to provide a clearer overview of Powerloom.
- Added sections for Quick Start, Development, Project Structure, Key Features, Contributing, and Troubleshooting.
- Updated installation and deployment instructions for better usability.
- Included environment variable configuration and resources for users.
Copy link
Contributor

@xadahiya xadahiya left a comment

Choose a reason for hiding this comment

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

Tested locally, builds are much faster now! Everything is working as expected. LGTM!

Copy link
Contributor

@Seth-Schmidt Seth-Schmidt left a comment

Choose a reason for hiding this comment

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

Looks good. Tested and working locally.

@SwaroopH SwaroopH merged commit 9808f2e into main Aug 5, 2025
2 checks passed
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.

4 participants