Skip to content

docs: add an English Codex plugin installation guide - #330

Merged
zengchuang-hw merged 9 commits into
InferMatrixLab:mainfrom
zengchuang-hw:codex/plugin-readme-quickstart
Nov 9, 2026
Merged

zengchuang-hw merged 9 commits into
InferMatrixLab:mainfrom
zengchuang-hw:codex/plugin-readme-quickstart

Conversation

@zengchuang-hw

@zengchuang-hw zengchuang-hw commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

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 the main URL. 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.

Agent-assisted-by: Codex
Signed-off-by: zengchuang <zengchuang3@huawei.com>
@Dong1017 Dong1017 added the area:usability Usability and collaboration: issue navigation, templates, readable reports label Nov 3, 2026 — with ChatGPT Codex Connector
Add the two-step native upload instructions and link the narrated installation guide.

Agent-assisted-by: Codex
Signed-off-by: zengchuang <zengchuang3@huawei.com>
@zengchuang-hw zengchuang-hw changed the title docs: add a Codex plugin quickstart to the README docs: add two-step Codex plugin installation and video guide Nov 3, 2026
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>
@zengchuang-hw zengchuang-hw changed the title docs: add two-step Codex plugin installation and video guide docs: add an English Codex plugin installation guide Nov 3, 2026
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>
@zengchuang-hw
zengchuang-hw marked this pull request as ready for review November 3, 2026 12:40

@Dong1017 Dong1017 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.

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 blob e64cb64823032230c1db646ddcc3e079306b55f3. 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.

@agent-ci-infra-bot agent-ci-infra-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewed commit: 269dca4
Coverage: Checkout: 2646 files at 269dca4 in a git worktree with the repository's history

Comment thread docs/codex-plugin.md Resolved
@agent-ci-infra-bot

Copy link
Copy Markdown

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 (pytest tests/test_template_layout.py tests/test_codex_plugin.py -q → 33 passed). One concrete defect remains: the new relative video link in the guide is dead in the shipped plugin README. No earlier reviews exist on this PR.

Labels: kind:docs (README and plugin-guide documentation delivery; area:usability is already set)

Reviewed commit: 269dca4
Coverage: Checkout: 2646 files at 269dca4 in a git worktree with the repository's history

@agent-ci-infra-bot agent-ci-infra-bot Bot added bot-reviewed kind:docs Documentation and template delivery labels Nov 3, 2026

Copy link
Copy Markdown
Collaborator

Review at head 269dca42: not approving yet.

  1. Broken video link in the shipped plugin README (docs/codex-plugin.md:38): tools/build_codex_plugin.py:75 copies docs/codex-plugin.md verbatim to the plugin's README.md, but the new link assets/inferrsi-codex-install-en.mp4?raw=1 is repository-relative and the MP4 is not in the plugin ZIP, so the link is dead for installed users (same as the existing bot finding F1, still unaddressed at this head). Expected: use an absolute GitHub URL (pinned to a tag/commit or the Release asset) or package the asset and adjust the path.
  2. Unverified client UI claims (README.md new "Use InferRSI in Codex" step 2; docs/codex-plugin.md:32-36): the exact menu path Plugins → Add → Upload plugin archive and Install plugin are stated as fact, while the PR says the video is an illustration that "does not record a completed installation". Has this flow been completed on a real Codex client? If not, please qualify the wording (e.g. "in clients that offer...") or record the client/version where it was verified.
  3. Removed update guidance (docs/codex-plugin.md, Updates section ~L113-123): the previous text explained that ZIP updates overlay files and removed runtime/resources must be deleted explicitly. It is replaced by "use the client's supported update or replacement flow". Please confirm the overlay/stale-file risk no longer applies to the upload flow, or keep that warning.

Agent-assisted-by: OpenAI Codex (implementer)
Signed-off-by: zengchuang <zengchuang3@huawei.com>

Copy link
Copy Markdown
Contributor Author

Thanks for the review. 47556c4 addresses all three points.

  • The README inside the ZIP now links to the video at an absolute canonical main URL. The released ZIP will use that URL after this PR adds the video to main. The candidate video matches the tracked bytes. An archive test now catches missing local README link targets.
  • Both guides make the menu and install button conditional on client support. A complete native Codex client installation remains unverified.
  • The Updates section explicitly retains the Plugin Creator overlay warning and the requirement to remove stale files. Native ZIP replacement behavior remains a client-specific check.

The 33 tests in the two affected test files passed. After the final URL adjustment, the four focused checks, Ruff, and independent review passed.

Copy link
Copy Markdown
Collaborator

Incremental review 269dca42..47556c44 (one commit, docs: fix the video link in the Codex plugin archive), checked against my previous review. Not approving yet; one point remains.

Resolved in this delta:

  • Point 2: both README.md step 2 and docs/codex-plugin.md:32-36 now make the menu path and Install plugin conditional on client support. Thanks.
  • Point 3: the Plugin Creator overlay / stale-file warning is kept (docs/codex-plugin.md Updates section), and native ZIP replacement is left as a client-specific check.
  • The new archive test in tests/test_codex_plugin.py (README link targets must exist inside the ZIP) is a good guard against the original dead relative link.

Still open:

  1. Video link is absolute but not pinned (docs/codex-plugin.md:38): the shipped plugin README now points at https://raw.githubusercontent.com/InferMatrixLab/InferRSI/main/docs/assets/inferrsi-codex-install-en.mp4. Because tools/build_codex_plugin.py copies this file verbatim into every versioned ZIP, a vX.Y.Z archive will always show whatever the video is on main at viewing time; renaming/replacing the asset later breaks or silently changes the guide for older releases, and the link 404s until this PR merges. My earlier request was a URL pinned to a tag/commit or the Release asset. Expected: either have the build script rewrite the link to the release tag (e.g. .../InferRSI/vX.Y.Z/docs/assets/...) or attach the MP4 as a Release asset and link that; if you intentionally prefer the moving main link, please state that trade-off in the PR description so the integrator can accept it explicitly.

CI at 47556c44: full-check (3.10/3.11) were still in progress when I looked; the other checks had passed.

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>

Copy link
Copy Markdown
Contributor Author

Thanks for the follow-up. 5e66b2f pins the installation-video URL in each versioned ZIP to refs/tags/vX.Y.Z. The release workflow publishes that tag at the same commit used to build the ZIP. The source guide and unversioned previews keep the main URL.

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
amy-why-3459 previously approved these changes Nov 4, 2026

@amy-why-3459 amy-why-3459 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.

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-86 rewrites the main raw video URL to refs/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 creates refs/tags/$RELEASE_TAG at the same RELEASE_COMMIT used to build the ZIP, so the pinned link resolves once the release is published.
  • tests/test_codex_plugin.py asserts the source guide still contains the main URL (so the replace cannot silently no-op) and that the release ZIP README equals the source with exactly that URL swapped.
  • docs/codex-plugin.md wording updated accordingly. CI at 5e66b2f9 is green.

Static review only; I did not build the archive or install it in a Codex client.

@zengchuang-hw

Copy link
Copy Markdown
Contributor Author

@Dong1017 PTAL

@Dong1017 Dong1017 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.

@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-policy reports 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.

Copy link
Copy Markdown
Contributor Author

Updated the PR description for 5e66b2f936282035f22741a95af2895d0d307f08 as requested in your recheck. It now describes the release-tag URL stamping and archive regressions, cites the current-head validation and reviews, and retains the native-installation and Issue-acceptance limits.

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>

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.com URL in docs/codex-plugin.md. Release builds rewrite main to refs/tags/v<release_version>.
  • The release-tag pin is implemented in tools/build_codex_plugin.py and applied in tools/plugin_bundle.py. Preview archives keep the source guide bytes.

Verified in the diff:

  • README.md installs Codex in two steps (download inferrsi-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 tracked docs/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_replacement is set only when release_version is set. plugin_bundle replaces that byte string once. The added URL appears once, as https://raw.githubusercontent.com/InferMatrixLab/InferRSI/main/docs/assets/inferrsi-codex-install-en.mp4.
  • tests/test_codex_plugin.py checks preview README bytes against docs/codex-plugin.md, rejects relative links whose targets are absent from the ZIP, requires that main video URL in the source guide, and expects the release ZIP README to be the source guide with main swapped for refs/tags/v0.2.0.

Not verified here:

  • Tests were not executed, and CI for cc5c53a was not in the seed.
  • MP4 contents (narration, subtitles, and the illustrated click path) were not inspected.
  • No Codex client installation. release.yml is outside this diff; the builder still matches the earlier --release-version tag-pin contract (version without a leading v).

@amy-why-3459 amy-why-3459 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.

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:

  • main moved the bundle logic into the new shared tools/plugin_bundle.py. The release-tag pin now lives there as an optional readme_replacement (tools/plugin_bundle.py:97, :127-131), applied once and only when tools/build_codex_plugin.py:20-29 sets it for a release build. Preview builds and the WorkSwarm builder pass None, so their README bytes are unchanged.
  • .github/workflows/release.yml:110-117 still builds the Codex ZIP with --release-version "${RELEASE_TAG#v}" from the tagged RELEASE_COMMIT, so the pinned refs/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, and main'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 cc5c53a7 passed (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.

@zengchuang-hw
zengchuang-hw merged commit 68dbd5e into InferMatrixLab:main Nov 9, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:usability Usability and collaboration: issue navigation, templates, readable reports bot-reviewed kind:docs Documentation and template delivery

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants