fix: devops-agent index sidebar position + table format (#125) #118
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: docs-sync | |
| on: | |
| pull_request: | |
| paths: | |
| - "skills/**" | |
| - "steering/**" | |
| - "examples/**" | |
| - "misc/**" | |
| - "devops-agent/**" | |
| - "README.md" | |
| - "CONTRIBUTING.md" | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: docs-sync-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs-sync: | |
| name: docs auto-gen blocks are in sync | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Regenerate and fail on diff | |
| run: | | |
| ./misc/update-all-references.sh --check | |
| ./misc/update-pages.sh --check | |
| - name: How to fix (shown on failure) | |
| if: failure() | |
| run: | | |
| cat >> "$GITHUB_STEP_SUMMARY" <<'EOF' | |
| ## Docs auto-gen blocks are stale | |
| One of the marker-delimited catalogues in `README.md` or `skills/README.md` (Skills Reference, Steering Reference, Examples Reference) diverged from the source of truth (`skills/*/SKILL.md`, `steering/**/*.md`, or `examples/**/README.md` frontmatter). The exact diff is in the job log above. | |
| **Fix:** | |
| ```bash | |
| ./misc/update-all-references.sh && ./misc/update-pages.sh && git add -A | |
| git commit -m "docs: regenerate reference tables and pages" | |
| ``` | |
| Full details: [`CONTRIBUTING.md` → Keeping docs in sync](../blob/${{ github.head_ref || github.ref_name }}/CONTRIBUTING.md#keeping-docs-in-sync-auto-generated-catalogues). | |
| EOF |