deploy-docs

Validate docs pages and generate a GitHub Pages deployment workflow.

25|15|Updated Aug 2, 2021
One-click install
npx skills add https://github.com/JesusFilm/core --skill deploy-docs-jesusfilm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deploy-docs
Source: https://github.com/JesusFilm/core/tree/main/.claude/skills/deploy-docs
Command: npx skills add https://github.com/JesusFilm/core --skill deploy-docs-jesusfilm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validates the documentation site and prepares it for GitHub Pages deployment, reducing manual checks and deployment risks.

Core Features & Use Cases

  • Validation checks: verifies the presence of required HTML pages and JSON configuration, and detects uncommitted changes.
  • Deployment prep: guides first-time setup by creating a GitHub Pages workflow and providing deployment instructions.
  • Operational readiness: ensures the docs are ready to publish after changes are merged, with a clear deployment path.

Quick Start

Validate the docs site and generate the GitHub Pages deployment workflow to publish the docs.

Frequently Asked Questions about deploy-docs

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

FAQPage Schema
How do I validate my docs site before deploying to GitHub Pages?

To validate your docs site for GitHub Pages deployment, check for required HTML pages and JSON configuration files while detecting uncommitted changes. This process identifies and fixes deployment blockers, ensuring operational readiness before publishing.

How do I generate a GitHub Pages deployment workflow for my documentation?

Generating a GitHub Pages deployment workflow involves creating a CI/CD configuration file that automatically publishes your docs after merges. This provides a clear deployment path and includes first-time setup instructions for continuous publishing.

What checks are needed to publish documentation to GitHub Pages without errors?

Publishing documentation to GitHub Pages requires validation checks for HTML presence, JSON file integrity, and uncommitted repository changes. These checks prevent deployment failures and ensure the docs site is ready to publish after code merges.

Why is my GitHub Pages deployment failing after merging documentation changes?

GitHub Pages deployment fails after merges when required HTML pages or JSON configuration files are missing or when uncommitted changes exist. Validating the docs site and generating a proper CI/CD workflow resolves these blocking issues.

Do I need a CI/CD workflow to automatically update GitHub Pages after merges?

You need a CI/CD workflow to automatically update GitHub Pages after merges. Generating a deployment workflow ensures your documentation site publishes automatically, eliminating manual checks and providing a continuous deployment path.