Repository navigation
docs: simplify user guides and correct setup instructions - #1857
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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
left a comment
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
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.
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
Testing
git diff --checkpassed.node scripts/generate-input-docs.mjs --checkandnode --import tsx --test tests/input-docs.test.ts tests/bedrock-example.test.tspassed fromgithub-action(two tests).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