Skip to content

docs: simplify user guides and correct setup instructions - #1857

Merged
mldangelo-oai merged 2 commits into
mainfrom
mdangelo/codex/user-facing-docs
Oct 22, 2026
Merged

mldangelo-oai merged 2 commits into
mainfrom
mdangelo/codex/user-facing-docs

Conversation

@mldangelo-oai

@mldangelo-oai mldangelo-oai commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Make the user guides easier to navigate and correct setup instructions that had drifted from supported behavior. Current workflows now appear before compatibility notes, with links to the detailed references.

Changes

  • Add a CLI task index, including local vendor imports, and import subheadings, use a shell example for Deep Scan, and place hosted execution under integrations.
  • Document project-file owner suggestions, show the Bedrock summary override, preserve the verified container image in the runner recipe, and correct classifier availability and package links.
  • Consolidate repeated policy and Action release explanations, move SDK compatibility notes out of onboarding, and lead the findings guide with local deduplication.

Testing

  • Checked all 155 existing heading anchors, 148 local links including inbound references, and 78 package-relative links in the affected guides.
  • Prettier checked all ten changed Markdown files; git diff --check passed.
  • node scripts/generate-input-docs.mjs --check and node --import tsx --test tests/input-docs.test.ts tests/bedrock-example.test.ts passed from github-action (two tests).
  • Commands and settings were checked against the current CLI, schema, resolver, and Compose configuration. No security scans or live service calls were run.

Risk and rollout

Documentation-only change. Existing documentation paths and heading anchors are preserved, and the generated Action input/output reference is unchanged.

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 22, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 22, 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-22T07:01:53.891727Z 36087d7 New commits
🔒 Security Review ✅ Completed 2026-10-22T07:01:54.630495Z 36087d7 New commits
ℹ️ 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.

@alandelong-oai alandelong-oai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for making the guides easier to navigate and correcting the setup examples. No blocking findings in this owner-level merge-safety review. The guides now lead with current workflows while retaining compatibility guidance and existing anchors; the owner-suggestion setting, Bedrock override, and verified container reference match the implementation.

Verified all ten changed guides, 154 preserved anchors, 143 local links and 73 package-relative links; formatting, SDK build, generated Action reference, two Action documentation tests, and CLI help/Deep Scan/Bedrock dry-runs passed. Configuration tests had 91 passes and three environment failures at the existing temporary-directory ownership guard. The hosted-remediation smoke check could not complete without a built bundled plugin; no live inference or container deployment was run.

@alandelong-oai alandelong-oai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for simplifying the guides and correcting the setup examples. No material findings in this owner-level merge-safety review of 36087d7. The verified container reference, Bedrock override, owner-suggestion configuration, CLI examples and package availability guidance match the implementation; compatibility details and existing anchors remain accessible.

Fresh checks passed for all ten changed guides: 155 preserved anchors, 148 local links, 78 package-relative links, formatting, the generated Action reference and two Action documentation tests under Node 24 with locked dependencies. This documentation-only review did not run a full runtime suite, live inference, hosted execution or a container deployment.

@mldangelo-oai
mldangelo-oai merged commit 64f0d8b into main Oct 22, 2026
68 checks passed
@mldangelo-oai
mldangelo-oai deleted the mdangelo/codex/user-facing-docs branch October 22, 2026 13:53
@github-actions github-actions Bot mentioned this pull request Oct 22, 2026
3 tasks done
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