Deploy docs
Validate and prepare documentation for GitHub Pages deploymentFrom its SKILL.md
npx -y skills add marcusrbrown/systematic --skill deploy-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
SKILL.md
2.6 KB, as published. Nobody here has run it
Deploy Documentation Command
Validate the documentation site and prepare it for GitHub Pages deployment.
Step 1: Validate Documentation
Run these checks:
# Count components
echo "Agents: $(ls plugins/systematic/agents/*.md | wc -l)"
echo "Skills: $(ls -d plugins/systematic/skills/*/ 2>/dev/null | wc -l)"
# Validate JSON
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid"
cat plugins/systematic/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json valid"
# Check all HTML files exist
for page in index agents commands skills mcp-servers changelog getting-started; do
if [ -f "plugins/systematic/docs/pages/${page}.html" ] || [ -f "plugins/systematic/docs/${page}.html" ]; then
echo "✓ ${page}.html exists"
else
echo "✗ ${page}.html MISSING"
fi
done
Step 2: Check for Uncommitted Changes
git status --porcelain plugins/systematic/docs/
If there are uncommitted changes, warn the user to commit first.
Step 3: Deployment Instructions
Since GitHub Pages deployment requires a workflow file with special permissions, provide these instructions:
First-time Setup
- Create
.github/workflows/deploy-docs.ymlwith the GitHub Pages workflow - Go to repository Settings > Pages
- Set Source to "GitHub Actions"
Deploying
After merging to main, the docs will auto-deploy. Or:
- Go to Actions tab
- Select "Deploy Documentation to GitHub Pages"
- Click "Run workflow"
Workflow File Content
name: Deploy Documentation to GitHub Pages
on:
push:
branches: [main]
paths:
- 'plugins/systematic/docs/**'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/configure-pages@v4
- uses: actions/upload-pages-artifact@v3
with:
path: 'plugins/systematic/docs'
- uses: actions/deploy-pages@v4
Step 4: Report Status
Provide a summary:
## Deployment Readiness
✓ All HTML pages present
✓ JSON files valid
✓ Component counts match
### Next Steps
- [ ] Commit any pending changes
- [ ] Push to main branch
- [ ] Verify GitHub Pages workflow exists
- [ ] Check deployment at https://everyinc.github.io/systematic/