docs-deploy

Deploy and verify the Weaverlet docs site to GitHub Pages via GitHub Actions.

2|1|Updated Jul 15, 2024
One-click install
npx skills add https://github.com/observatoriogeo/weaverlet --skill docs-deploy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-deploy
Source: https://github.com/observatoriogeo/weaverlet/tree/main/.claude/skills/docs-deploy
Command: npx skills add https://github.com/observatoriogeo/weaverlet --skill docs-deploy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents documentation changes from lingering only in the repo by providing a reliable, repeatable way to deploy and verify the live Weaverlet documentation site on weaverlet.observatoriogeo.mx.

Core Features & Use Cases

  • End-to-end GitHub Pages deployment: Uses the single repository workflow (.github/workflows/docs-deploy.yml) to build and publish the docs from website/ to Pages.
  • Version-aware documentation handling: Supports the Docusaurus setup that ships both next (from website/docs/) and the frozen snapshot (from website/versioned_docs/version-0.3.1/).
  • Build-and-deploy verification loop: Guides you through local build validation, pushing, monitoring the workflow, and smoke-testing the deployed site for common failure modes (like trailing-slash issues).
  • Standalone sync checks: Confirms whether local website changes have shipped by comparing local state, origin/main, and the latest successful workflow run.

Quick Start

Ask to deploy or redeploy the docs site for weaverlet.observatoriogeo.mx, then run the local build check and push the website/** changes on main to trigger the GitHub Actions workflow.

Frequently Asked Questions about docs-deploy

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

FAQPage Schema
How do I deploy a Docusaurus site to GitHub Pages using a CI workflow?

To deploy a Docusaurus site to GitHub Pages, push your website directory changes to the main branch to trigger a GitHub Actions CI workflow that builds with Node 20, caches the lockfile, and publishes the site while preserving the custom CNAME domain.

How do I verify my local documentation changes have synced with the published GitHub Pages site?

Verify documentation sync by comparing your local website directory state against origin/main and the latest successful GitHub Actions workflow run, then perform a smoke test on the live site to catch common publication failures like trailing-slash issues.

Does the Docusaurus versioned docs deployment workflow support both next and frozen snapshot versions?

Docusaurus versioned docs deployment supports both the next version built from website/docs and the frozen snapshot built from website/versioned_docs, ensuring the GitHub Pages site accurately reflects both current and archived documentation.

What is the best way to update production documentation on a custom domain without lingering repo changes?

Updating production documentation on a custom domain requires running a local build validation from the website directory, pushing changes to main to trigger the GitHub Actions workflow, and monitoring the deployment to confirm the live site reflects the latest updates.

Why does my GitHub Pages documentation deployment fail when building versioned Docusaurus content?

GitHub Pages documentation deployment may fail during versioned Docusaurus builds if the pinned Node 20 build environment is altered, lockfile caching is misconfigured, or the versioned_docs directory structure does not match the expected workflow paths.

Do I need a specific Node version to build and deploy Docusaurus documentation to GitHub Pages?

Building and deploying Docusaurus documentation to GitHub Pages requires using the pinned Node 20 build specified in the GitHub Actions workflow to ensure consistent compilation, lockfile caching, and successful publication to the target repository.