Repository navigation
docs: add an English Codex plugin installation guide #330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
zengchuang-hw
wants to merge
6
commits into
InferMatrixLab:main
Choose a base branch
from
zengchuang-hw:codex/plugin-readme-quickstart
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ec5f234
docs: add a Codex plugin quickstart to the README
zengchuang-hw e3137eb
docs: align plugin installation with the Codex upload UI
zengchuang-hw edfaec2
docs: open the installation video directly from guide links
zengchuang-hw 6443894
docs: show the installation step after plugin import
zengchuang-hw 860505f
docs: make the Codex installation guide fully English
zengchuang-hw 269dca4
docs: link to the installation video without a README preview
zengchuang-hw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Binary file not shown.
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
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
docs/codex-plugin.md:38[Watch or download the installation guide ...](assets/inferrsi-codex-install-en.mp4?raw=1)is repository-relative, butdocs/codex-plugin.mdis copied verbatim into every release ZIP asinferrsi/README.md(tools/build_codex_plugin.py:75), and the archive never containsdocs/assets. The guide itself promisesREADME.mdinside the archive (docs/codex-plugin.md:25), andtools/check_release.py:124restricts plugin entries toplugin.json, skills, runtime, LICENSE, README.md, soassets/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.inferrsi-codex-install-en/inferrsi-codex-plugin-vX.Y.Z.zip) clicks the video link.docs/copy works.https://github.com/InferMatrixLab/InferRSI/blob/main/docs/assets/inferrsi-codex-install-en.mp4?raw=1(or an equivalent raw/release URL), or havetools/build_codex_plugin.pyrewrite/map the path while honouringcheck_plugin's allowed entries. A regression check that bundled-README relative links resolve would prevent this from recurring.