Skip to content

docs(readme): put npm first and fold desktop downloads into small chips - #5718

Merged
lidge-jun merged 1 commit into
devfrom
codex/readme-npm-first
Sep 24, 2026
Merged

lidge-jun merged 1 commit into
devfrom
codex/readme-npm-first

Conversation

@lidge-jun

Copy link
Copy Markdown
Owner

Summary

The README led with three large platform download buttons and a long desktop section above and below the npm command, which pushed the CLI install down. This puts npm first again and makes the desktop app a small, optional path:

  • The first code block is npm install -g @bitkyc08/opencodex / ocx start, as before the desktop launch.
  • Directly under it, a collapsed Desktop app (beta) block holds four npm-badge-sized chips: macOS .dmg, Windows .msi, Linux .AppImage, Linux .deb, each linking to the latest release. The Windows chip uses an inline four-pane mark because shields.io's simple-icons set no longer ships a Windows logo.
  • The separate desktop release badge is removed from the badge row.
  • Quick start starts with Personal install (CLI) again; Desktop app (beta) follows as one short paragraph (formats, signing state, link to the Desktop App guide) instead of the table, widget, and build details, which live in the guide.
  • assets/download-{macos,windows,linux}.svg are no longer referenced, so they are deleted and dropped from package.json files.
  • All seven locale READMEs get the same change in their language, and readme/i18n-manifest.json is resynced.

A README cannot link straight to the newest installer file: release assets carry the version in their names (OpenCodex-2.64.0-macos.dmg), so releases/latest/download/<name> would need unversioned copies uploaded by the release workflow. The chips therefore open the latest release page.

Screenshots

README on GitHub (this branch, desktop block expanded):

README npm first with desktop chips

Verification

  • bun test tests/ci-workflows/docs-readme-translation-parity.test.ts tests/ci-workflows/repo-hygiene.test.ts tests/ci-workflows/docs-link-targets.test.ts tests/ci-workflows/install-scripts.test.ts tests/ci-workflows/file-size-ratchet.test.ts → 94 pass, 0 fail (locale structure, commands, links, assets and manifest hash; README assets shipped in the npm tarball).
  • bun run privacy:scan passed; git diff --check clean.
  • Checked each chip's shields.io URL returns an SVG with an embedded logo (apple, linux, debian, inline Windows mark).
  • No src/ changes, so bun run test / typecheck were not run locally.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults.

The README led with three large download buttons and a long desktop section. npm install is the first command again; the desktop downloads are four npm-sized badges (macOS .dmg, Windows .msi, Linux .AppImage and .deb) in a collapsed block under it, and the Quick start desktop section is one short paragraph after the CLI install. The unused download SVGs are removed from assets and the npm files list. All seven locales are resynced.
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 24, 2026 00:54
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-24T00:57:30.054409Z 7893a94 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 24, 2026
@coderabbitai

coderabbitai Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Repository: lidge-jun/opencodex/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 26cdc9f1-3bf5-4686-9d87-e49240be5afd

📥 Commits

Reviewing files that changed from the base of the PR and between 129406f and 7893a94.

⛔ Files ignored due to path filters (3)
  • assets/download-linux.svg is excluded by !**/*.svg
  • assets/download-macos.svg is excluded by !**/*.svg
  • assets/download-windows.svg is excluded by !**/*.svg
📒 Files selected for processing (10)
  • README.md
  • package.json
  • readme/README.fr.md
  • readme/README.ja.md
  • readme/README.ko.md
  • readme/README.ru.md
  • readme/README.tr.md
  • readme/README.zh-CN.md
  • readme/README.zh-TW.md
  • readme/i18n-manifest.json
 __________________________________________________________________________________
< This is the beginning of a beautiful friendship...between you and bug-free code. >
 ----------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lidge-jun
lidge-jun merged commit bb003b7 into dev Sep 24, 2026
33 of 34 checks passed
@lidge-jun
lidge-jun deleted the codex/readme-npm-first branch September 24, 2026 00:55

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7893a94643

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md

The same proxy and dashboard in a native window, with a tray and a bundled `ocx`. Download the universal `.dmg`
(macOS 13+), the `.msi` (Windows x64, not code-signed yet) or the `.AppImage` / `.deb` (Linux x86_64)
from the [latest release](https://github.com/lidge-jun/opencodex/releases/latest). The [Desktop App guide](https://opencodex.me/guides/desktop-app/) covers first launch and local builds.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore the missing local-build instructions

For readers trying to build the desktop app locally, this link now claims the Desktop App guide covers local builds, but docs-site/src/content/docs/guides/desktop-app.md contains only installation, first-launch, usage, update, widget, and uninstall guidance. Because this commit also removes the only cross-platform build commands from the README, those instructions are no longer available through the advertised path; either restore them here or add a local-build section to the linked guide and its translations.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant