Skip to content

docs(cli): clarify scan scope and recovery guidance - #1660

Open
mldangelo-oai wants to merge 1 commit into
mainfrom
mdangelo/codex/scan-scope-docs
Open

mldangelo-oai wants to merge 1 commit into
mainfrom
mdangelo/codex/scan-scope-docs

Conversation

@mldangelo-oai

Copy link
Copy Markdown
Collaborator

Summary

A completed scan can retain exclusions, deferred review work, or unanswered questions. Explain how to inspect the saved evidence and decide whether to analyze the findings, run a focused follow-up, or recover an interrupted run.

Changes

  • Add a scan-scope guide covering manifest, report, coverage, and log inspection by scan ID.
  • Explain the limits of per-file coverage evidence, legacy completeness labels, saved rerun recipes, and Deep Scan resume eligibility.
  • Link the guide from the README and distinguish GitHub alert retrieval from importing a findings file into local history.

Testing

  • node sdk/typescript/scripts/check-markdown.mjs — passed.
  • Prettier check for README.md and sdk/typescript/docs/cli.md — passed.
  • Source CLI help for scans show, scans logs, scans rerun, and scans resume — checked against the documented examples.
  • git diff --check — passed.
  • Focused history, file-import, and scan-failure tests — 155 passed.
  • Targeted legacy-completeness/status tests and the Deep Scan accepted-worker coverage check — passed.
  • GitHub import tests — 23 passed; one validation test failed locally because the bundled plugin is not built. No runtime files change in this PR.
  • Two additional Python history tests failed on local filesystem ownership/permission checks; the remaining selected Python history test passed.
  • Independent technical review against the scan implementation completed before publication.

Risk and rollout

Documentation only; no runtime behavior, public CLI syntax, defaults, or artifact formats change. The guide distinguishes current behavior from legacy reports and does not promise exhaustive per-file coverage or recovery without the original saved state.

Public disclosure review

  • No customer, partner, prospect, or user identities, data, or identifying details are included.
  • No credentials, personal data, private source, scan findings, or nonpublic links or tickets are included.
  • I reviewed the branch name, title, description, commits, changes, comments, logs, screenshots, attachments, and links for public disclosure.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 16, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-16T03:09:41.990478Z 5342aef PR opened
🔒 Security Review ✅ Completed 2026-10-16T03:10:46.585948Z 5342aef PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants