Skip to content

feat: enable faster Docusaurus builds and clarify beta rollback#443

Merged
elibosley merged 1 commit intomainfrom
codex/docusaurus-faster-build-pr
Apr 1, 2026
Merged

feat: enable faster Docusaurus builds and clarify beta rollback#443
elibosley merged 1 commit intomainfrom
codex/docusaurus-faster-build-pr

Conversation

@elibosley
Copy link
Copy Markdown
Member

@elibosley elibosley commented Apr 1, 2026

Summary

  • enable Docusaurus Faster with the required v4 compatibility flag and lockfile updates
  • fix the repo TypeScript/editor issues that surfaced while validating the config change
  • clarify the 7.3.0-beta.2 rollback guidance for TPM/internal boot users and update AGENTS.md so full builds are allowed when explicitly requested

Validation

  • pnpm exec tsc --noEmit
  • pnpm run build

Build notes

  • the full build now passes
  • Docusaurus still emits existing content warnings for broken links, broken anchors, and nested HTML tags in docs content across locales
  • Docusaurus also warns that siteConfig.onBrokenMarkdownLinks is deprecated and that babel.config.js can be removed when using the SWC loader

Summary by CodeRabbit

  • Documentation

    • Updated rollback guidance with more flexible recovery options for recent releases.
    • Clarified repository validation directives.
  • Chores

    • Enabled build performance optimizations and faster bundling.
    • Updated TypeScript configuration for improved type checking.
    • Added dependency to support optimized build processes.

- Purpose: turn on Docusaurus Faster for this docs site and document the beta.2 rollback path more clearly.
- Before: the repo used the default Docusaurus build path, the faster flags were not configured, full-build validation was blocked even when explicitly requested, and TypeScript editor checks failed on React JSX and local type declarations.
- Problem: build-speed improvements were unavailable, the new faster config was not wired for this repo, rollback guidance for TPM/internal boot users was ambiguous, and the TS failures made config validation noisy.
- Change: add @docusaurus/faster, enable the experimental_faster flags with the required v4 compatibility flag, update the 7.3.0-beta.2 notes to allow rollback to 7.3.0-beta.1 but not 7.2.4 or earlier after TPM/internal boot, relax AGENTS.md so full builds are allowed when explicitly requested, and fix the TS config and local declarations so tsc passes.
- How it works: Docusaurus now uses the faster SWC/Rspack path, the config opts into the required future flag for worker-thread SSG, the React/iframe typings are aligned with the current toolchain, and the edited docs text matches the actual supported rollback path.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

The changes modernize the TypeScript configuration and build setup while updating dependency declarations, refactoring module declarations, and adjusting documentation guidance. Configuration updates enable Docusaurus build optimizations and extend React/TypeScript type definitions.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md, docs/unraid-os/release-notes/7.3.0.md
Updated validation and rollback guidance with conditional rules and build-specific permissions instead of absolute prohibitions.
Build & Dependency Configuration
docusaurus.config.ts, package.json
Added @docusaurus/faster dependency and enabled Docusaurus v4 future features including SWC/Rspack optimizations for build performance; fixed trailing whitespace in redirect URL.
TypeScript Configuration
tsconfig.json
Configured jsx compiler option to react-jsx and added explicit types list for Node, React, and Docusaurus type definitions.
Type Declarations & Component Updates
sidebar-semver-sort.d.ts, src/types/react-augmentations.d.ts, src/components/HomepageFeatures/index.tsx
Refactored sidebar utilities to top-level TypeScript declarations, added React module augmentation for credentialless iframe attribute, and updated component prop types to use React.ReactNode and React.JSX.Element.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~20 minutes

Poem

🐰 A faster hop through build so fine,
Types refined in every line!
React augmented, configs shine,
With Docusaurus by design,
Our bundle speeds—now that's divine! ✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Description check ❓ Inconclusive The description covers the three main changes, includes validation steps, and explains build results, but does not address the repository's template checklist items. Complete the pre-submission checklist from the description template to confirm all documentation standards and quality checks have been met.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main objectives: enabling Docusaurus Faster builds and clarifying beta rollback guidance.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docusaurus-faster-build-pr

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
unraid-docs 7efc062 Commit Preview URL

Branch Preview URL
Apr 01 2026, 08:47 PM

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/unraid-os/release-notes/7.3.0.md (1)

26-26: Tighten scope at Line 26 to avoid mixed interpretation.

Line 26 can read as a general rollback path suggestion, while Line 22 is a hard prohibition for internal-boot/TPM-enabled testers. Consider scoping this sentence explicitly to avoid ambiguity (and it also resolves the repeated “If” style hint).

✏️ Suggested wording
-If you are considering any rollback path below `7.3.0-beta.1`, also see the [7.2.4 release notes](/unraid-os/release-notes/7.2.4/).
+For systems that did **not** enable internal boot or TPM-based licensing, any rollback path below `7.3.0-beta.1` should also be validated against the [7.2.4 release notes](/unraid-os/release-notes/7.2.4/).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/unraid-os/release-notes/7.3.0.md` at line 26, The sentence on Line 26 is
ambiguous relative to the hard prohibition on Line 22—make Line 26 explicitly
scoped so it only applies to non‑TPM/internal‑boot users; replace the current
line with a scoped sentence such as: "For users not using internal‑boot or TPM
(i.e., standard BIOS/UEFI installs), if you are considering any rollback path
below 7.3.0‑beta.1, also see the 7.2.4 release notes." This clarifies intent and
removes the mixed interpretation while preserving the rollback pointer.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/unraid-os/release-notes/7.3.0.md`:
- Line 26: The sentence on Line 26 is ambiguous relative to the hard prohibition
on Line 22—make Line 26 explicitly scoped so it only applies to
non‑TPM/internal‑boot users; replace the current line with a scoped sentence
such as: "For users not using internal‑boot or TPM (i.e., standard BIOS/UEFI
installs), if you are considering any rollback path below 7.3.0‑beta.1, also see
the 7.2.4 release notes." This clarifies intent and removes the mixed
interpretation while preserving the rollback pointer.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c0a1741f-65de-4cfc-8a9c-b5b48a75acd3

📥 Commits

Reviewing files that changed from the base of the PR and between 6b3ba7c and 7efc062.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (8)
  • AGENTS.md
  • docs/unraid-os/release-notes/7.3.0.md
  • docusaurus.config.ts
  • package.json
  • sidebar-semver-sort.d.ts
  • src/components/HomepageFeatures/index.tsx
  • src/types/react-augmentations.d.ts
  • tsconfig.json

@elibosley elibosley merged commit 712bcbb into main Apr 1, 2026
3 of 4 checks passed
@elibosley elibosley deleted the codex/docusaurus-faster-build-pr branch April 1, 2026 20:55
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.

1 participant