Skip to main content

deploy-docs

Validate and prepare documentation for GitHub Pages deployment

설치로 이동

소스 정보

저장소
All-The-Vibes/ATV-StarterKit
최근 소스 활동
2026년 4월 28일 18:30
감지된 SKILL.md 언어
영어
스타
51
포크
15

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
deploy-docs
description
Validate and prepare documentation for GitHub Pages deployment
disable-model-invocation
true
# Deploy Documentation Command Validate the documentation site and prepare it for GitHub Pages deployment. ## Step 1: Validate Documentation Run these checks: ```bash # Count components echo "Agents: $(ls plugins/compound-engineering/agents/*.md | wc -l)" echo "Skills: $(ls -d plugins/compound-engineering/skills/*/ 2>/dev/null | wc -l)" # Validate JSON cat .github/plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid" cat plugins/atv-everything/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/compound-engineering/docs/pages/${page}.html" ] || [ -f "plugins/compound-engineering/docs/${page}.html" ]; then echo "✓ ${page}.html exists" else echo "✗ ${page}.html MISSING" fi done ``` ## Step 2: Check for Uncommitted Changes ```bash git status --porcelain plugins/compound-engineering/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 1. Create `.github/workflows/deploy-docs.yml` with the GitHub Pages workflow 2. Go to repository Settings > Pages 3. Set Source to "GitHub Actions" ### Deploying After merging to `main`, the docs will auto-deploy. Or: 1. Go to Actions tab 2. Select "Deploy Documentation to GitHub Pages" 3. Click "Run workflow" ### Workflow File Content ```yaml name: Deploy Documentation to GitHub Pages on: push: branches: [main] paths: - 'plugins/compound-engineering/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/compound-engineering/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/compound-engineering-plugin/ ```
GitHub에서 보기