docs: fix inaccuracies found during the README rewrite - #235
Conversation
|
@codex review |
|
@codex security review |
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. |
2b18873 to
2aaca31
Compare
|
@codex review |
|
@codex security review |
|
Codex Review: Didn't find any major issues. What shall we delve into next? Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
… options table Change-Id: I50985e9036cea8902da623b88ca11627f598152d Signed-off-by: Thomas Kosiewski <tk@coder.com>
Change-Id: Id4788263c585a6e546dcf147cdb815ade7b60ca1 Signed-off-by: Thomas Kosiewski <tk@coder.com>
Change-Id: I0cc8cb86b7a37a70b94cad70cf728df7d3d220de Signed-off-by: Thomas Kosiewski <tk@coder.com>
Change-Id: Iddfe1960280de6f659bf0ecea1154e02d8b31474 Signed-off-by: Thomas Kosiewski <tk@coder.com>
Change-Id: I81b536bd2918a3c85f87d280f7e9bcd057634a66 Signed-off-by: Thomas Kosiewski <tk@coder.com>
2aaca31 to
9059b1f
Compare
|
@codex review |
|
@codex security review |
|
Codex Review: Didn't find any major issues. Keep them coming! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
Fixes pre-existing inaccuracies found while rewriting the docs in #234. Follow-up to #234 (merged).
Verification tier: verified against source for every item.
requestTimeoutMs: the agent options table called it a "per‑turn time budget". It bounds each server segment, not the whole call (packages/agent/src/agent/coder-agent.tsoption doc, and the README's Timeouts section). The table now says "per‑segment … not per call".src/prompt.ts,src/generate.ts). It now says they can be wrong, and that release-please's own output cannot be changed by them.new CoderAgent({ /* … */ })placeholders omitted the requiredorganizationId. They now pass it; all five typecheck (negative control: the old placeholders fail with TS2345).examples/,src/, sibling packages) are now absolute GitHub URLs. (Shippingdocs/itself moved into docs: rewrite READMEs for readability and split long guides into docs/ #234.)Validation:
pnpm checkpasses; the link and anchor checker finds 0 broken links.Generated with
xum• Model:anthropic:claude-opus-5-5• Thinking:high