Update Docusaurus, Yarn deps, and SHA-pin GitHub Actions - #47
Merged
Conversation
Bring the site to Docusaurus 3.10.2 with v4 future flags, pin workflow actions by digest, and fix strict MDX plus markdownlint so the production build succeeds. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
This PR modernizes the site toolchain and CI for the Docusaurus-based documentation site, aligning dependency versions and hardening GitHub Actions usage.
Changes:
- Upgrades Docusaurus to
3.10.2(plus related deps like React19.2.8) and refreshesyarn.lock. - Improves GitHub Actions security/reproducibility by SHA-pinning key actions and switching markdown linting to
markdownlint-cli2. - Fixes/adjusts documentation formatting (MDX-safe comments, code fences, image alt text) and adds markdownlint config files.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| yarn.lock | Refreshed lockfile to match updated Docusaurus/React and transitive deps. |
| sidebars.js | Updates sidebar config formatting and moves to an exported sidebars object. |
| README.md | Updates Docusaurus reference/link to v3. |
| package.json | Pins Docusaurus packages, updates core deps, and adds Node engines constraint. |
| LICENSE.md | Updates copyright line and normalizes formatting. |
| docusaurus.config.js | Migrates config to typed/ESM style, adds prism themes, future flags, and other config updates. |
| docs/install/unraid.md | Improves image alt text and formatting for markdownlint/MDX. |
| docs/install/docker.md | Marks a code fence as shell. |
| docs/install/configuration.md | Replaces HTML comments with MDX-safe JSX comments. |
| babel.config.js | Removes Babel config file. |
| .markdownlint.json | Adds markdownlint rule configuration. |
| .markdownlint-cli2.jsonc | Adds markdownlint-cli2 ignore configuration. |
| .github/workflows/deploy.yml | SHA-pins actions, adds concurrency/permissions, and tweaks deploy setup. |
| .github/workflows/build.yml | SHA-pins actions, replaces markdownlint action, and adds permissions. |
| .github/renovate.json | Adjusts Renovate config for digest pinning and automerge rules. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+24
to
28
| markdown: { | ||
| hooks: { | ||
| onBrokenMarkdownLinks: 'warn', | ||
| }, | ||
| }, |
Drop the Ruby mdl config and README, and run the same yarn lint command locally and in CI. Co-authored-by: Cursor <cursoragent@cursor.com>
This was referenced Aug 26, 2026
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
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
yarn buildsucceeds.Test plan
Buildworkflow passes on this PRyarn buildsucceeds locally (already verified)Made with Cursor