site-reliability-engineer

Validate Docusaurus MDX syntax and site builds for CI deployment gates.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/CenredJun/openclaw-claudecode-setup-kit --skill site-reliability-engineer-cenredjun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: site-reliability-engineer
Source: https://github.com/CenredJun/openclaw-claudecode-setup-kit/tree/main/skills/site-reliability-engineer
Command: npx skills add https://github.com/CenredJun/openclaw-claudecode-setup-kit --skill site-reliability-engineer-cenredjun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires glob, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Prevents Docusaurus site build failures and unsafe deployments by catching MDX syntax, template, and asset issues early so site maintainers do not ship broken documentation pages.

Core Features & Use Cases

  • Pre-commit MDX validation: Fast checks for unescaped Liquid templates, unescaped angle brackets, and SkillHeader prop issues before committing.
  • Pre-build and post-build checks: Link validation and post-build health reports to gate deployments and surface warnings as CI artifacts.
  • CI integration and deployment gating: Produces machine-readable health reports and a deployment gate script suitable for GitHub Actions pipelines.
  • Use Case: Maintain a Claude Skills showcase site by running pre-commit hooks and CI checks to ensure builds succeed and no broken links or missing assets reach production.

Quick Start

Run the website pre-commit validation and CI health checks to surface MDX, link, and SkillHeader issues before deployment.

Frequently Asked Questions about site-reliability-engineer

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

FAQPage Schema
How do I prevent Docusaurus build failures caused by unescaped Liquid templates?

Prevent Docusaurus build failures by running pre-commit MDX validation that detects unescaped Liquid templates, angle-bracket issues, and SkillHeader prop requirements before code is committed. It catches syntax errors early so broken documentation pages never reach deployment.

Can I gate deployments using Docusaurus post-build health reports in CI/CD?

Yes, you can gate deployments using CI-compatible health reports generated after the Docusaurus build. The reports surface link validation warnings and MDX issues as CI artifacts, producing a deployment gate script suitable for GitHub Actions pipelines.

What is the best way to validate MDX syntax and links before a Docusaurus deployment?

The best way to validate MDX syntax and links is applying pre-build link checking and pre-commit validation to catch unescaped templates and missing assets. This prevents broken pages from reaching production by surfacing issues during local development and CI.

Does this Docusaurus validation tool work with GitHub Actions CI/CD pipelines?

Yes, this Docusaurus validation tool works with GitHub Actions by producing machine-readable health reports and a deployment gate script. It integrates into CI/CD pipelines to enforce build health checks and block unsafe deployments of broken documentation.

Why does my Docusaurus MDX build fail on angle-bracket issues and SkillHeader props?

Docusaurus MDX builds fail on angle-bracket issues and SkillHeader props when syntax is unescaped or required properties are missing. Pre-commit validation detects these specific MDX formatting problems early, preventing build failures and deployment downtime.