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.