docs: remediate all documentation review findings#440
Merged
Conversation
Critical: - README examples called nonexistent workflow/action inputs; regenerated every example from the actual workflow_call and action.yml inputs - copilot-instructions.md referenced nonexistent reusable-ci-rust.yml Major: - update-profile-readme.yml pushed directly to protected main, was rejected (GH006), and the retry loop swallowed the failure — profile stale since 2026-03 while runs reported success. Now opens an auto-merge PR via the App token and fails loudly (set -euo pipefail) - All positive doc examples now pin actions to full commit SHAs instead of @main/@v4 (README, skills, agents, presentations README) - profile ccpkg link fixed (plugin-packaging -> ccpkg); MIF/ccpkg spec deep links fixed to /specification/overview/ - README private template repo links de-linked and marked private - attested-delivery skill: Purpose/Triggers/Usage sections, allowed-tools frontmatter, trigger-phrase description - CONTRIBUTING development setup rewritten for this repo's toolchain - README structure tree updated (attested set, presentation skills, profile-maintainer agent) Minor: - Broken 3-backtick fence nesting fixed with 4-backtick outer fences in copilot-tuner, ecosystem-migrator, ai-tuning, ecosystem-migration, presentation-generation, presentations README (also fixes the phantom assets/diagram.png broken image) - ~40 unlabeled code fences given language tags - Nonexistent validate-sha-pinning.sh/validate-workflows.sh references replaced with actionlint + pin grep - profile-maintainer agent aligned to shared agent structure - example presentation author corrected; LICENSE (MIT) added; CHANGELOG
There was a problem hiding this comment.
Pull request overview
This PR remediates a broad set of documentation-quality findings across the repository, focusing on making examples copy/paste safe, aligning docs with current workflows/actions/inputs, and repairing the profile README automation to respect branch protection.
Changes:
- Regenerated README/skill/agent examples to match real
workflow_calland composite-action inputs, and updateduses:references to full 40-char SHA pins. - Reworked the profile README updater workflow to open an auto-merge PR via a GitHub App token instead of attempting direct pushes to protected
main. - Fixed markdown structure/link integrity issues (code fence nesting, missing fence languages, updated/renamed links) and added an MIT
LICENSE.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates repository structure/docs, adds attested-delivery section, and refreshes workflow/action usage examples with SHA pins. |
| profile/README.md | Updates external spec/repo links for MIF and ccpkg. |
| LICENSE | Adds MIT license text to back the README’s license claim. |
| docs/presentations/README.md | Fixes markdown fence nesting and updates workflow usage pin for presentation generation. |
| docs/presentations/drafts/example-presentation.md | Corrects example author metadata. |
| CONTRIBUTING.md | Replaces generic setup boilerplate with repo-specific tooling guidance (actionlint, gh-aw compilation, pin-check). |
| CHANGELOG.md | Documents the documentation remediation and automation fixes as a “Fixed” set of entries. |
| agents/workflow-engineer.md | Updates examples/fences and pins reusable workflow usage; adds action pin annotations. |
| agents/template-architect.md | Fixes markdown fence language for the workflow diagram. |
| agents/security-auditor.md | Updates checkout pin to a full SHA with version annotation. |
| agents/profile-maintainer.md | Aligns agent doc structure and fixes fence language tags; adds “When Assisting Users” guidance. |
| agents/ecosystem-migrator.md | Updates examples/pins, fixes nested fences, and replaces obsolete validation scripts with actionlint/grep guidance. |
| agents/copilot-tuner.md | Fixes nested markdown fences (4-backtick outer fences) for correct rendering. |
| agents/content-strategist.md | Adds language tags for code fences for consistent rendering. |
| .github/workflows/update-profile-readme.yml | Changes profile update publishing strategy from direct push to PR-based auto-merge via GitHub App token; improves shell safety. |
| .github/skills/workflow-development/SKILL.md | Updates workflow/action examples to SHA pins and modern validation guidance. |
| .github/skills/template-creation/SKILL.md | Adds explicit fence language tag for directory layout example. |
| .github/skills/security-baseline/SKILL.md | Replaces placeholder action reference with a fully pinned example SHA. |
| .github/skills/presentation-generation/SKILL.md | Updates description wording and fixes nested fences for markdown correctness. |
| .github/skills/ecosystem-migration/SKILL.md | Updates examples/pins and replaces obsolete validation scripts with actionlint/grep guidance. |
| .github/skills/content-pipeline/SKILL.md | Adds explicit fence language tags for examples/diagrams. |
| .github/skills/attested-delivery/SKILL.md | Brings skill doc into stricter format (Purpose/Triggers/Usage + allowed-tools). |
| .github/skills/ai-tuning/SKILL.md | Fixes nested markdown fences (4-backtick outer fences). |
| .github/prompts/analyze-repo-activity.prompt.md | Adds an explicit fence language tag for the usage example. |
| .github/copilot-instructions.md | Fixes fence language tags and removes the nonexistent reusable Rust CI workflow reference; adds reusable-docs. |
Comments suppressed due to low confidence (1)
README.md:188
- The
security-scancomposite actionlanguagevalues in this example don’t match the action’s documented inputs (python,node,go,auto). Usingjavascript/rusthere is misleading and can cause copy/paste failures.
scan-secrets: true
scan-dependencies: true
language: python # or javascript, go, rust
</details>
Comment on lines
+193
to
+196
| - uses: zircote/.github/actions/release-notes@2192c47863886d7a867b5042fb08de414f948f49 # main | ||
| with: | ||
| version: ${{ github.ref_name }} | ||
| output-file: CHANGELOG.md | ||
| from-tag: v1.0.0 | ||
| include-contributors: true |
Comment on lines
+145
to
+149
| - name: Generate App token | ||
| id: app-token | ||
| if: steps.changes.outputs.changed == 'true' && inputs.dry-run != true | ||
| uses: actions/create-github-app-token@bf559f85448f9380bcfa2899dbdc01eb5b37be3a # v3.0.0 | ||
| with: |
Comment on lines
112
to
114
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| # ... implementation |
Comment on lines
95
to
+97
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 | ||
| - uses: zircote/.github/actions/setup-python-uv@main | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| - uses: zircote/.github/actions/setup-python-uv@2192c47863886d7a867b5042fb08de414f948f49 # main |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Remediates every finding from the documentation quality review (2 critical, 7 major, 8 minor):
workflow_call/action.ymlinputs (the old ones failed at workflow startup if copied); phantomreusable-ci-rust.ymlreference removed.update-profile-readme.ymlwas silently failing for 3 months — direct pushes to protected main were GH006-rejected and the retry loop swallowed the error. Now opens an auto-merge PR via the GitHub App token withset -euo pipefail.@2192c47… # mainfor this repo's workflows/actions; current release SHAs for third-party actions). Only deliberately-labeled WRONG examples and audit grep patterns retain mutable refs.Validation
actionlintclean on the modified workflow (including the pre-existing SC2046 in the step I touched)lychee(offline + online, badges excluded): 0 errors across all public-facing docs