tuyaopen-build-check

Verify Docusaurus builds for TuyaOpen documentation and detect link, MDX, and sidebar errors.

4|25|Updated Apr 23, 2025
One-click install
npx skills add https://github.com/Tuya-Community/TuyaOpen.io --skill tuyaopen-build-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tuyaopen-build-check
Source: https://github.com/Tuya-Community/TuyaOpen.io/tree/main/.cursor/skills/tuyaopen-build-check
Command: npx skills add https://github.com/Tuya-Community/TuyaOpen.io --skill tuyaopen-build-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures the Docusaurus documentation for TuyaOpen builds successfully and catches errors such as broken links, MDX syntax errors, and sidebar mismatches, enabling developers to verify changes and maintain accurate documentation.

Core Features & Use Cases

  • Automated Build Verification: Validates the correctness of the Docusaurus build, ensuring documentation changes are properly compiled and rendered.
  • Broken Link Detection: Identifies and alerts developers to broken internal links in the documentation.
  • MDX Syntax Errors: Highlights and resolves MDX syntax errors for clean rendering of the documentation.
  • Sidebar Validation: Ensures that the documentation's sidebar accurately reflects the content, maintaining user navigation integrity.
  • Quick Start & Troubleshooting: Provides simple commands to run builds and quick checks, as well as troubleshooting guidance for common issues.
  • i18n Support: Supports the verification of builds for multilingual documentation.

Quick Start

Run the full build check with npm run build.

Frequently Asked Questions about tuyaopen-build-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find broken links and MDX syntax errors in my Docusaurus build?

To find broken links and MDX syntax errors in a Docusaurus build, run the build verification process. It executes build commands to detect and resolve link, MDX syntax, and sidebar configuration issues automatically.

Why does my Docusaurus build fail with sidebar validation errors?

A Docusaurus build fails with sidebar validation errors when the documentation sidebar does not accurately reflect the content. Build verification identifies these mismatches to maintain user navigation integrity.

Can I verify multilingual Docusaurus documentation builds?

Yes, you can verify multilingual Docusaurus documentation builds. The build verification supports i18n, allowing developers to check and ensure proper compilation and rendering across different languages.

What is the best way to validate documentation changes before committing?

The best way to validate documentation changes before committing is to run a local build check. This verifies that Docusaurus changes compile successfully and catches errors like broken links and MDX syntax issues early.

How do I troubleshoot common Docusaurus build errors?

To troubleshoot common Docusaurus build errors, execute the build check to highlight issues. It provides specific guidance for resolving MDX syntax errors, broken links, and sidebar mismatches to ensure clean rendering.