Repository navigation
[DEV-2203] Keep AI docs independent of deferred platform changes - #322
Merged
Merged
Conversation
tonytlwu
marked this pull request as ready for review
October 16, 2026 17:02
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. |
Deploying fliplet-cli with
|
| Latest commit: |
9b4d298
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5c6c42a9.fliplet-cli.pages.dev |
| Branch Preview URL: | https://codex-dev-2203-scope-split.fliplet-cli.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Product areas affected
Developer AI reference, workflow guides, navigation, data-source security reference and generated AI discovery indexes.
What does this PR do?
Removes pending filter/payload recipes and the deferred configurable completion timeout from the published contract. Replaces the private-write AI tool example with public sample lookup and a confirmed local-state assignment. Keeps server authorization requirements explicit for real private data/shared writes. Preserves historical source in the merged commit and separate DEV tickets.
Broadens the media-input guide to File and image analysis. Separates provider/model/format compatibility from the bounded PDF/image extraction recipe. Covers prose answers, summaries and comparisons without forcing a schema or editable form; keeps extraction validation and authorization. Updates incoming navigation/discovery labels and preserves the public URL and legacy section anchor. Executable example fences are unchanged.
JIRA ticket
DEV-2203, DEV-2204 and DEV-2205
Result
220 docs unit/example tests pass on this revision. Desktop and 390px mobile rendering inspected; final raw media-inputs Markdown matches source. Strict agent index passes. Jekyll renders successfully; 210 Markdown siblings and 17 discovery files copied. Tests demonstrate tool/result replay, valid public reads, Confirm/Cancel, repeated assignment, invalid arguments/types, incomplete output and bounded recovery.
Checklist
Deployment instructions
Publish the corrected documentation before releasing Studio #9046, whose instructions use the new canonical paths. No CLI binary/runtime or version bump. Matching API and Studio changes are separate PRs. Pending contracts must not be reintroduced before their independent releases.
Author concerns
The replacement action changes local sample state only and resets on reload. It does not demonstrate server-authorized private writes. Jekyll emits existing Liquid warnings in unrelated Best-practises.md and API/v3/auth.md. User waived independent subagent review for the split.
File-input engineering qualification
Synthetic DOCX, XLSX, CSV, non-animated GIF and PNG fixtures returned known answers through the split-branch JavaScript SDK completion implementation, with an HTTP bridge to the isolated local API and gpt-6.1-sol Responses. Tasks covered prose Q&A, quantities across two sheets and visual shape/order recognition. This qualifies only the tested small-file SDK/API path. The API runtime remains the older combined revision (1659de1e6); its provider-forwarding implementation matches the split branch. This is not browser/native, large-workbook or fresh generated-app verification, nor a PASS for the pending QA evidence-pack plan. Additional formats and delivery modes require representative app-path checks.
Canonical AI guide URLs
/API/core/ai/web-search(Web search and citations) replacesgrounded-answers./API/core/ai/file-and-image-analysisreplacesmedia-inputs..htmland.mdURL. Markdown remains Markdown; existing section anchors remain available. Navigation, JS/REST cross-links, discovery indexes, Studio known paths/fallback search and eval document references use canonical paths. Scenario/criterion IDs and executable example fences remain unchanged.