What does deploy-docs validate?

It validates the Eleventy build output, checks for the presence of key docs pages, and ensures component cards match the source files, then prepares for deployment.

How do I trigger deployment?

The skill responds to triggers like deploy docs, publish documentation, GitHub Pages, or validate docs site, and can also be run via the GitHub Actions workflow.

Where is the deployment performed?

Deployment is handled by the GitHub Actions workflow at .github/workflows/deploy-docs.yml and can be kicked off manually from Actions.

deploy-docs

Scanned

npx machina-cli add skill jikig-ai/soleur/deploy-docs --openclaw

Files (1)

SKILL.md

2.5 KB

Deploy Documentation Command

Validate the documentation build and prepare it for GitHub Pages deployment.

Step 1: Build and Validate

# Install dependencies (if needed)
npm ci

# Run Eleventy build
npx @11ty/eleventy

# Verify build output
test -f _site/index.html && echo "OK index.html"
test -f "_site/pages/agents.html" && echo "OK agents.html"
test -f "_site/pages/skills.html" && echo "OK skills.html"
test -f "_site/pages/changelog.html" && echo "OK changelog.html"
test -f "_site/pages/getting-started.html" && echo "OK getting-started.html"
test -f _site/404.html && echo "OK 404.html"
test -f _site/css/style.css && echo "OK style.css"
test -f _site/CNAME && echo "OK CNAME"
test -f _site/sitemap.xml && echo "OK sitemap.xml"

Step 2: Verify Component Counts

Use Grep to count occurrences of component-card in _site/pages/agents.html and _site/pages/skills.html.

Then compare with source counts using Glob:

Agent files: count .md files (excluding README.md) under plugins/soleur/agents/
Skill files: count SKILL.md files under plugins/soleur/skills/

Cards in the output must match source file counts exactly.

Step 3: Check for Uncommitted Changes

git status --porcelain plugins/soleur/docs/ eleventy.config.js package.json

If there are uncommitted changes, warn the user to commit first.

Step 4: Deployment

Deployment is automated via .github/workflows/deploy-docs.yml:

Trigger: Push to main that changes docs, agents, skills, commands, plugin.json, or eleventy.config.js
Manual: Go to Actions > "Deploy Documentation to GitHub Pages" > "Run workflow"

The workflow:

Checks out the repo
Installs Node.js 20 and npm dependencies
Runs npx @11ty/eleventy to build
Verifies all required files are present
Uploads _site/ as a Pages artifact
Deploys to GitHub Pages

Step 5: Report Status

Provide a summary:

## Deployment Readiness

OK All HTML pages present
OK CSS and fonts present
OK Component counts match source
OK CNAME and sitemap present

### Next Steps
- [ ] Commit any pending changes
- [ ] Push to main branch
- [ ] Verify deployment at https://soleur.ai/

Source

git clone https://github.com/jikig-ai/soleur/blob/main/plugins/soleur/skills/deploy-docs/SKILL.mdView on GitHub

Overview

The deploy-docs skill validates a documentation build with Eleventy, confirms key output files exist, and ensures component card counts match source files before deployment. It guides you through a GitHub Pages deployment workflow to keep docs reliable.

How This Skill Works

It installs dependencies, runs the Eleventy build, and verifies essential output files such as index.html, agents.html, skills.html, changelog.html, getting-started.html, 404.html, CSS, and sitemap. It then checks that the number of component cards in the generated pages matches the source counts and flags uncommitted changes prior to triggering the deployment workflow.

When to Use It

Before publishing docs to GitHub Pages
After updating agents or skills to validate changes
When validating a fresh Eleventy build
If there are uncommitted changes before deployment
During CI for main branch changes affecting docs

Quick Start

Step 1: Run npm ci to install dependencies
Step 2: Run npx @11ty/eleventy to build the docs site
Step 3: Check for required files and run git status before deployment

Best Practices

Run in CI or locally before merging changes to main
Verify all required output files exist after the build
Keep agent and skill source counts in sync with generated cards
Commit any pending changes before deployment
Review git status to avoid deploying uncommitted changes

Example Use Cases

Deploy updated agent documentation after adding a new agent
Publish skill page updates following SKILL.md edits
Resolve missing 404.html or sitemap.xml before deploy
Update getting-started and changelog pages alongside code changes
Rerun deploy-docs after Eleventy configuration updates

Frequently Asked Questions

Add this skill to your agents