Skip to content

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

Open
zengchuang-hw wants to merge 6 commits into
InferMatrixLab:mainfrom
zengchuang-hw:codex/plugin-readme-quickstart
Open

zengchuang-hw wants to merge 6 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

README Quickstart presents two steps: download inferrsi-codex-plugin-vX.Y.Z.zip from GitHub Releases, then install it in Codex. The second step distinguishes Plugins → Add → Upload plugin archive from the subsequent Install plugin action on the InferRSI detail page. Once installed, enable the plugin and start a new conversation.

README provides a plain Installation video (English) link to the video file, without an embedded preview or thumbnail. The maintained plugin guide also links to the 49-second video. Narration, subtitles, UI labels and instructions are English. Codex scenes are labeled Translated UI illustration, using localized versions of the requester's sanitized screenshots; they do not depict a completed account installation. Existing wheel/source CLI instructions and ZIP-only distribution remain unchanged.

Validation: exact head 269dca420a08f46661b4f9f988ab116b2940b5a5 passed independent review. The README contains one plain video link, exactly two installation steps and no preview/embed; the target exists, no removed-poster references remain, and whitespace checks pass. English video bytes and guide are unchanged from the independently reviewed 860505f output: 49 seconds, 1,398,314 bytes, 1080p/24fps/H.264+AAC, English stream metadata and successful full audio/video decode. This changes documentation/media only; no runtime tests were added or repeated.

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
prompts. After installation, enable InferRSI, open your target repository and
start a new conversation.

[Watch or download the installation guide (English narration and subtitles)](assets/inferrsi-codex-install-en.mp4?raw=1).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

F1 — medium, must-fix — broken link in the shipped plugin README

  • Where: docs/codex-plugin.md:38
  • Problem: the new link [Watch or download the installation guide ...](assets/inferrsi-codex-install-en.mp4?raw=1) is repository-relative, but docs/codex-plugin.md is copied verbatim into every release ZIP as inferrsi/README.md (tools/build_codex_plugin.py:75), and the archive never contains docs/assets. The guide itself promises README.md inside the archive (docs/codex-plugin.md:25), and tools/check_release.py:124 restricts plugin entries to plugin.json, skills, runtime, LICENSE, README.md, so assets/ cannot be shipped without changing the release contract. I built the plugin locally and confirmed the result: asset files in archive: [], relative link: assets/inferrsi-codex-install-en.mp4?raw=1 -> exists in archive: False.
  • Conditions: any reader of the installed/extracted plugin README (the copy inside inferrsi-codex-install-en/inferrsi-codex-plugin-vX.Y.Z.zip) clicks the video link.
  • Impact: the only video reference in the distributed plugin guide resolves to a non-existent path, so the installation tutorial is unreachable from the shipped artifact; only the GitHub-rendered docs/ copy works.
  • Fix: use an absolute URL for this link (many links in this guide are already absolute), e.g. https://github.com/InferMatrixLab/InferRSI/blob/main/docs/assets/inferrsi-codex-install-en.mp4?raw=1 (or an equivalent raw/release URL), or have tools/build_codex_plugin.py rewrite/map the path while honouring check_plugin's allowed entries. A regression check that bundled-README relative links resolve would prevent this from recurring.

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

2 participants