Repository navigation
docs(readme): put npm first and fold desktop downloads into small chips - #5718
Conversation
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.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
✅ Deterministic PR hygiene checks passed. |
|
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 configurationConfiguration used: Repository: lidge-jun/opencodex/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (10)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
💡 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".
|
|
||
| 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. |
There was a problem hiding this comment.
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 👍 / 👎.
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:
npm install -g @bitkyc08/opencodex/ocx start, as before the desktop launch..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.desktoprelease badge is removed from the badge row.assets/download-{macos,windows,linux}.svgare no longer referenced, so they are deleted and dropped frompackage.jsonfiles.readme/i18n-manifest.jsonis 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), soreleases/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):
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:scanpassed;git diff --checkclean.src/changes, sobun run test/typecheckwere not run locally.Checklist