deploy-docs

Validate documentation artifacts for GitHub Pages deployment readiness.

Updated Nov 11, 2023
One-click install
npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill deploy-docs-michaelvolz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deploy-docs
Source: https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb/tree/main/.opencode/skills/ce/deploy-docs
Command: npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill deploy-docs-michaelvolz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates validation of the Compound Engineering documentation site so that missing pages, invalid JSON, or unstaged edits do not break GitHub Pages deployment.

Core Features & Use Cases

  • Documentation validation: Counts agents and skills, ensures marketplace and plugin JSON pass jq checks, and confirms each core HTML page exists in the docs folders.
  • Clean workspace enforcement: Inspects git status for uncommitted changes under plugins/compound-engineering/docs/ and prompts for commits before deployment.
  • Deployment guidance: Summarizes first-time workflow requirements, workflow permissions, and manual trigger steps so teams can push docs safely.

Quick Start

Validate the documentation site and prepare it for GitHub Pages deployment before merging.

Frequently Asked Questions about deploy-docs

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

FAQPage Schema
How do I validate documentation files before deploying to GitHub Pages?

Validate documentation files before GitHub Pages deployment by checking agent and skill counts, verifying JSON structures with jq, and confirming all expected HTML pages exist in the docs directory.

What does git status inspection do for documentation deployment safety?

Git status inspection for documentation deployment safety detects uncommitted changes in the docs directory and prompts for commits, preventing broken or incomplete pages from reaching production.

How do I check if plugin JSON files are valid before publishing HTML documentation?

Check plugin JSON files before publishing HTML documentation by running jq validation on marketplace and plugin JSON structures to ensure they parse correctly and meet deployment requirements.

Do I need to commit all changes before triggering a GitHub Pages workflow?

Yes, you need a clean workspace before triggering a GitHub Pages workflow; the validation inspects git status for unstaged edits in the docs folder and prompts for commits to guarantee deploy safety.

What happens if expected HTML pages are missing from the plugin docs directory?

Missing HTML pages in the plugin docs directory cause validation to fail, blocking the deployment process so incomplete documentation cannot be published to GitHub Pages.

Can I automate documentation validation for multiple HTML pages and JSON files?

Automate documentation validation across multiple HTML pages and JSON files through repeated file existence checks and jq structural validation, summarizing workflow permissions and manual trigger steps for safe deployment.