Repository navigation
docs: add an English Codex plugin installation guide - #330
zengchuang-hw merged 9 commits into
Conversation
Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Add the two-step native upload instructions and link the narrated installation guide. Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Clarify the detail-page Install plugin action and refresh the narrated guide. Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Translate the quickstart instructions and tutorial narration, captions and UI illustrations. Preserve the separate Install plugin action after ZIP import. Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Keep a plain text link to the English video file and remove the unused preview poster. Agent-assisted-by: Codex Signed-off-by: zengchuang <zengchuang3@huawei.com>
Dong1017
left a comment
There was a problem hiding this comment.
Static text review at 269dca42 is consistent with the README/guide request recorded in Issue #238; video content and actual client installation remain unverified.
- README now has two main installation steps and separates ZIP upload/import from the subsequent Install plugin action. Python/Git prerequisites, the client ZIP-support qualification and first-task prompts are present; the existing CLI path is retained.
- README's plain video link and the guide's relative media link resolve to the tracked MP4 path. The guide anchor exists, and both documents label the UI scenes as illustrations rather than a completed upload/installation.
- zengchuang-hw retains the media/client evidence and maintainer integration follow-up. This review found no additional textual scope discrepancy; it does not certify the video, a particular Codex build's menu availability, or Issue acceptance.
Evidence and limits
- Head:
269dca420a08f46661b4f9f988ab116b2940b5a5; API base / assessed main:663f3b327998526a13aa31e72ad729025c18983c. - Read the complete README and plugin guide, their two-file textual diff and the three-path change list against the governing Issue record.
- Tracked video:
docs/assets/inferrsi-codex-install-en.mp4, Git blobe64cb64823032230c1db646ddcc3e079306b55f3. Presence/link resolution is verified; the connector rejects non-UTF-8 media. I did not download/decode/watch/listen to it, inspect the private source screenshots or perform a client import. The reported 49-second duration, English narration/subtitles and successful decode remain author-attributed evidence. - No local suite, runtime installation, model/API call or workflow action by this review. Existing green software checks are separate from documentation/media and client acceptance. This is COMMENTED feedback, not a full media review or formal approval.
|
This docs/media PR adds an English two-step Codex plugin quickstart to README, rewrites the maintained plugin guide's install/update wording to the native upload flow, and adds a 49-second English MP4. The README/guide wording matches the requester constraints and the documentation tests pass ( Labels: kind:docs (README and plugin-guide documentation delivery; Reviewed commit: 269dca4 |
|
Review at head
|
Agent-assisted-by: OpenAI Codex (implementer) Signed-off-by: zengchuang <zengchuang3@huawei.com>
|
Thanks for the review. 47556c4 addresses all three points.
The 33 tests in the two affected test files passed. After the final URL adjustment, the four focused checks, Ruff, and independent review passed. |
|
Incremental review Resolved in this delta:
Still open:
CI at Static review only; I did not build the archive or install it in a Codex client. |
Agent-assisted-by: OpenAI Codex (implementer) Signed-off-by: zengchuang <zengchuang3@huawei.com>
|
Thanks for the follow-up. 5e66b2f pins the installation-video URL in each versioned ZIP to The archive checks verify the exact tag URL in the stamped README and byte-for-byte preservation of the preview README. Both focused tests, Ruff, and independent review passed. |
amy-why-3459
left a comment
There was a problem hiding this comment.
LGTM
Incremental review 47556c44..5e66b2f9 (one commit, docs: pin the packaged Codex video to the release tag), checked against my previous review.
- The remaining point is resolved:
tools/build_codex_plugin.py:75-86rewrites themainraw video URL torefs/tags/v<release_version>only for release builds; unversioned previews keep the README byte-for-byte. - This matches
.github/workflows/release.yml, which passes--release-version "${RELEASE_TAG#v}"and createsrefs/tags/$RELEASE_TAGat the sameRELEASE_COMMITused to build the ZIP, so the pinned link resolves once the release is published. tests/test_codex_plugin.pyasserts the source guide still contains themainURL (so the replace cannot silently no-op) and that the release ZIP README equals the source with exactly that URL swapped.docs/codex-plugin.mdwording updated accordingly. CI at5e66b2f9is green.
Static review only; I did not build the archive or install it in a Codex client.
|
@Dong1017 PTAL |
Dong1017
left a comment
There was a problem hiding this comment.
@zengchuang-hw Rechecked 269dca42..5e66b2f9 at exact head 5e66b2f936282035f22741a95af2895d0d307f08. No new blocker found in the documentation/packaging delta.
- The original bundled-README defect is fixed: the guide now uses an absolute video URL, and the builder pins it to
refs/tags/v<release_version>for release ZIPs. The release workflow builds from and publishes that tag at the same commit. My earlier relative-link check covered the repository copy, not the installed README; it did not establish that the old archive link worked. - The archive tests check local README targets, unchanged preview bytes and the exact release-tag rewrite. Both installation guides now qualify client UI availability, and the Plugin Creator stale-file warning remains. This reconciles F1 and Amy's three points, including the later pinning request.
- All seven visible check runs at this SHA passed in CI;
knowledge-model-policyreports success / “Not applicable”.
Integration follow-up: the old F1 thread is still unresolved, although its code defect is addressed. Please also refresh the PR description: it still cites 269dca42 and “documentation/media only”, whereas this head includes builder and archive-test changes. GitHub currently reports the PR as blocked; green checks alone are not a merge-readiness claim.
Static review only: I did not rerun tests, build the ZIP, watch/decode the video or perform a Codex installation. Media/client validation and Issue #238 acceptance remain separate.
|
Updated the PR description for I also resolved the old F1 thread, using the recorded fix, Amy's current-head approval and your independent confirmation. This follow-up updates PR metadata and thread state. The validation evidence remains tied to the same head; a second eligible formal approval is still pending. |
Preserve the host plugin links and carry the Codex release video pinning into the shared bundle builder. Agent-assisted-by: OpenAI Codex (implementer) Signed-off-by: zengchuang <zengchuang3@huawei.com>
There was a problem hiding this comment.
LGTM
PR review verdict — PASS
Reviewed base 4715f95795718cda461500f61fd418d8ed72ff9b and head cc5c53a76347b6ee00fdb4c42bab7e0afab79950 (full diff; no previous head was seeded).
Earlier findings on this PR are resolved in this head:
- F1, the shipped plugin README video link, is an absolute
raw.githubusercontent.comURL indocs/codex-plugin.md. Release builds rewritemaintorefs/tags/v<release_version>. - The release-tag pin is implemented in
tools/build_codex_plugin.pyand applied intools/plugin_bundle.py. Preview archives keep the source guide bytes.
Verified in the diff:
README.mdinstalls Codex in two steps (downloadinferrsi-codex-plugin-vX.Y.Z.zip, then Plugins → Add → Upload plugin archive and Install plugin when that action is offered). The CLI wheel path remains. The README video target is the trackeddocs/assets/inferrsi-codex-install-en.mp4, and the guide links use#install-from-the-release-zip. The diff does not remove that heading.- The guide states that menu labels depend on the client, and that the video is English UI illustrations of the click order. The updates section still says Plugin Creator overlays leave omitted files installed, and tells the reader to verify native ZIP replacement on the target client.
readme_replacementis set only whenrelease_versionis set.plugin_bundlereplaces that byte string once. The added URL appears once, ashttps://raw.githubusercontent.com/InferMatrixLab/InferRSI/main/docs/assets/inferrsi-codex-install-en.mp4.tests/test_codex_plugin.pychecks preview README bytes againstdocs/codex-plugin.md, rejects relative links whose targets are absent from the ZIP, requires thatmainvideo URL in the source guide, and expects the release ZIP README to be the source guide withmainswapped forrefs/tags/v0.2.0.
Not verified here:
- Tests were not executed, and CI for
cc5c53awas not in the seed. - MP4 contents (narration, subtitles, and the illustrated click path) were not inspected.
- No Codex client installation.
release.ymlis outside this diff; the builder still matches the earlier--release-versiontag-pin contract (version without a leadingv).
amy-why-3459
left a comment
There was a problem hiding this comment.
LGTM
PR review verdict — PASS
Incremental re-review 5e66b2f936282035f22741a95af2895d0d307f08..cc5c53a76347b6ee00fdb4c42bab7e0afab79950 (one merge commit, Merge main into the Codex installation guide branch; base now 4715f95795718cda461500f61fd418d8ed72ff9b). My earlier approval at 5e66b2f9 was dismissed by this push; re-approving at the new head.
Checked the merge resolution against the PR's own diff:
mainmoved the bundle logic into the new sharedtools/plugin_bundle.py. The release-tag pin now lives there as an optionalreadme_replacement(tools/plugin_bundle.py:97,:127-131), applied once and only whentools/build_codex_plugin.py:20-29sets it for a release build. Preview builds and the WorkSwarm builder passNone, so their README bytes are unchanged..github/workflows/release.yml:110-117still builds the Codex ZIP with--release-version "${RELEASE_TAG#v}"from the taggedRELEASE_COMMIT, so the pinnedrefs/tags/v<version>video URL resolves after publish.tests/test_codex_plugin.py:206-212(local README link targets exist in the ZIP) and:256-271(exact tag rewrite for Codex, byte-identical README for WorkSwarm) cover both hosts of the parametrized release fixture.README.md: the Codex two-step section keeps the conditional client wording, andmain's DeepSeek Harness / WorkSwarm install lines are preserved under "Use InferRSI in other clients"; the CLI wheel path is retained.- All six check runs at
cc5c53a7passed (full-check 3.10/3.11, installed-package 3.10/3.11, declarations, pr-references).
Static review only; I did not build the archive or install it in a Codex client.
Refs #238
Adds an English two-step Codex ZIP installation quickstart to README and the maintained plugin guide, with a plain text link to a 49-second English video. The instructions qualify client menu/button availability and preserve the Plugin Creator update-cleanup warning. Codex scenes are labeled Translated UI illustration and use localized versions of the supplied sanitized screenshots.
Release builds stamp the bundled README's video URL to
refs/tags/v<release_version>. The release workflow publishes that tag at the same source commit used to build the ZIP. Source guides and unversioned previews use themainURL. Archive regressions cover local README link targets, preview/source byte preservation and the exact release-tag URL rewrite.At head
5e66b2f936282035f22741a95af2895d0d307f08, the Ready run passed all six jobs and the knowledge-policy check reports success / Not applicable. The recorded focused archive validation and Ruff passed. Amy's approval and Dong1017's technical recheck cover this head.Native Codex upload/installation and ZIP replacement behavior remain unverified. Maintainer integration and Issue #238 acceptance remain pending.