Skip to content

Nightly scanner should be less nit-picky about docs#1921

Merged
derekmisler merged 1 commit intodocker:mainfrom
derekmisler:only-recommend-documentation-fixes-on-markdown-fil
Mar 4, 2026
Merged

Nightly scanner should be less nit-picky about docs#1921
derekmisler merged 1 commit intodocker:mainfrom
derekmisler:only-recommend-documentation-fixes-on-markdown-fil

Conversation

@derekmisler
Copy link
Contributor

@derekmisler derekmisler commented Mar 4, 2026

Summary

The nightly codebase scanner's documentation agent was filing issues about missing doc comments in Go source files (e.g., #1912). This PR scopes the documentation agent to only analyze .md files, raises the bar so it only reports high-impact issues, and fixes a pipefail crash in the auto-issue-triage workflow.

Changes

Nightly scanner documentation agent (nightly-scanner.yaml):

  • Restricted scope to .md files only — source code doc comments are no longer in scope
  • Replaced the "what to look for" list with high-impact-only criteria: factually incorrect info, missing setup/build steps, broken critical links
  • Expanded the "what to ignore" list to explicitly exclude style nits, typos, nice-to-have sections, and internal feature docs
  • Added a default-to-NO_ISSUES directive so findings only get reported if they would genuinely block or mislead a contributor

Auto-issue-triage workflow (auto-issue-triage.yml):

  • Fixed grep exit code 1 causing the "Parse agent result" step to fail under bash pipefail when the agent output contains no RESULT: marker (e.g., this run)

Test plan

  • Trigger a dry-run of the nightly scan (workflow_dispatch with dry-run=true) and verify the documentation agent only analyzes .md files
  • Verify the auto-issue-triage workflow no longer fails at the "Parse agent result" step when the agent doesn't output a result marker

Signed-off-by: Derek Misler <derek.misler@docker.com>
@derekmisler derekmisler marked this pull request as ready for review March 4, 2026 15:25
@derekmisler derekmisler requested a review from a team as a code owner March 4, 2026 15:25
Copy link

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

Assessment: 🟢 APPROVE

This PR successfully scopes the nightly scanner's documentation agent to only analyze markdown files and fixes a pipefail crash in the auto-issue-triage workflow.

Changes reviewed:

  • ✅ Documentation agent now explicitly scoped to .md files only with clear instructions to ignore source code
  • ✅ High-impact-only criteria properly defined (factually incorrect info, missing setup steps, broken critical links)
  • ✅ grep command correctly fixed with || true to prevent pipefail crashes when no RESULT marker is found

All changes are correct. The grep fix properly handles the case where the pattern is not found by setting an empty string, which falls through to the else block that sets action=none. No bugs detected in the changed code.

Findings

No issues found. The code changes work as intended.

description: Documentation gaps and improvements
instruction: |
You analyze code for documentation issues. Only report significant gaps.
You analyze markdown documentation files for issues. Only report significant gaps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we maybe expand it to the actual gh pages style docs as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those were just turned into markdown files, so I think this'll work? I'll keep an eye on it.

@derekmisler derekmisler merged commit c0cf18d into docker:main Mar 4, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants