chore(ci): document docs workflow paths-filter intent#2175
Merged
imran-siddique merged 1 commit intoMay 12, 2026
Merged
Conversation
`.github/workflows/docs.yml` triggers on changes to four narrow paths: `site/**`, `mkdocs.yml`, `docs/**`, and the workflow file itself. Why each entry is on the list isn't obvious to a reader trying to extend the doc site — e.g. is `docs/**` for content, derived API docs, or both? does `mkdocs.yml` belong here or in `site/**`? Add a block comment that names each input and explains the intentional narrow filter (docs are derived from this input set, not from the full repository — a Python source change should not republish the docs). Pure documentation change; no behavior change.
🤖 AI Agent: docs-sync-checker — Docs SyncDocs SyncDocumentation is in sync. |
🤖 AI Agent: security-scanner — View detailsNo security issues found. |
🤖 AI Agent: test-generator — View detailsTest coverage looks good. No gaps identified. |
🤖 AI Agent: code-reviewer — View detailsNo issues found. Clean change. |
🤖 AI Agent: breaking-change-detector — View detailsNo breaking changes detected. |
|
🟡 Contributor Check: MEDIUM
Automated check by AGT Contributor Check. |
PR Review Summary
Verdict: ✅ Ready for human review |
MohammadHaroonAbuomar
pushed a commit
to MohammadHaroonAbuomar/agt-acs
that referenced
this pull request
Jun 1, 2026
`.github/workflows/docs.yml` triggers on changes to four narrow paths: `site/**`, `mkdocs.yml`, `docs/**`, and the workflow file itself. Why each entry is on the list isn't obvious to a reader trying to extend the doc site — e.g. is `docs/**` for content, derived API docs, or both? does `mkdocs.yml` belong here or in `site/**`? Add a block comment that names each input and explains the intentional narrow filter (docs are derived from this input set, not from the full repository — a Python source change should not republish the docs). Pure documentation change; no behavior change.
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
2 participants
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
.github/workflows/docs.ymltriggers on changes to four narrow paths:site/**,mkdocs.yml,docs/**, and the workflow file itself. Why each entry is on the list isn't obvious to a reader trying to extend the doc site — e.g. isdocs/**for content, derived API docs, or both? Doesmkdocs.ymlbelong here or insite/**?The audit asked specifically for
mkdocs.yml's presence in the trigger to be documented; while there, every entry deserves a one-liner.Change
Add a block comment naming each input and explaining the intentional narrow filter:
site/**— extra static assets copied into the buildmkdocs.yml— site config (nav, theme, plugins)docs/**— the actual markdown sources.github/workflows/docs.yml— itself, so changes to the build/deploy logic still trigger a rebuild even when no content movedPlus a closing line that names the trade-off explicitly: docs are derived from this input set, not from the full repository.
Pure documentation change; no behavior change.
Verification
actionlintparses cleanly.Surfaced during independent audit conducted by @finnoybu (Ken Tannenbaum, AEGIS Initiative); [LOW, Infrastructure/CI].