deploy-docs

Validate generated documentation and GitHub Actions workflow for GitHub Pages deployment.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/xbpk3t/ce-codex --skill deploy-docs-xbpk3t
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: deploy-docs
Source: https://github.com/xbpk3t/ce-codex/tree/main/skills/deploy-docs
Command: npx skills add https://github.com/xbpk3t/ce-codex --skill deploy-docs-xbpk3t

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the validation and preparation steps required to safely publish generated documentation to GitHub Pages, removing manual checks and reducing deployment regressions.

Core Features & Use Cases

  • Documentation Validation: Counts generated components, verifies existence of required HTML pages, and validates JSON manifests to catch generation errors early.
  • Repository Readiness Checks: Runs git status inspections to detect uncommitted changes and provides clear next steps for committing and pushing documentation changes.
  • Deployment Guidance: Outlines the required GitHub Actions workflow configuration and permissions to enable GitHub Pages deployment.
  • Use Case: After a CI job generates site artifacts for the compound-engineering-plugin, use this Skill to confirm artifacts are complete, JSON is valid, and the Pages workflow is configured before publishing.

Quick Start

Validate the documentation site, ensure all generated HTML pages and JSON files are present and valid, and prepare or verify the GitHub Pages workflow for deployment.

Frequently Asked Questions about deploy-docs

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

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

To validate documentation for GitHub Pages deployment, you must verify required HTML pages exist, confirm generated JSON manifests parse cleanly without errors, and check that all expected site artifacts are present. This catches generation errors before publishing.

What GitHub Actions workflow permissions are needed for GitHub Pages deployment?▼

GitHub Pages deployment requires a GitHub Actions workflow configured with pages write permissions. You must ensure this specific workflow configuration is present in your repository to enable automated publishing of generated documentation.

How do I check if my repository is ready to publish documentation to GitHub Pages?▼

To check repository readiness for publishing documentation, inspect git status to detect uncommitted changes, verify all generated components are present, and confirm the Pages workflow is configured. This ensures a clean state before pushing deployment updates.

Does this documentation validation work with CI-generated site artifacts?▼

Yes, documentation validation works directly with CI-generated site artifacts. After a CI job generates site artifacts, it confirms artifacts are complete, validates JSON manifests, and verifies the GitHub Pages workflow configuration before publishing.

Why is my GitHub Pages deployment failing after generating documentation?▼

GitHub Pages deployment fails when generated JSON manifests contain syntax errors, required HTML pages are missing, or the GitHub Actions workflow lacks pages write permissions. Validating these elements beforehand prevents deployment regressions.