docs(contributing): fix Windows desktop setup - #5145
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthrough
ChangesContributor setup documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 219-223: Update the dev:app:win port guidance around
OPENHUMAN_DEV_PORT to require checking both the configured port and its derived
HMR port (OPENHUMAN_DEV_PORT + 1) for availability and exclusion from listed
ranges. Ensure the guidance also prevents selecting 65535 as the base port,
since the companion HMR port must remain valid.
- Around line 69-71: Update the LIBCLANG_PATH example in the contributing
documentation to use executable PowerShell syntax: assign the quoted path
through the $env:LIBCLANG_PATH environment-variable form and label the code
block as powershell.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: e4ba2390-0996-4b31-be5f-a1863d5414ba
📒 Files selected for processing (1)
CONTRIBUTING.md
…uidance - Fix LIBCLANG_PATH example to use PowerShell $env: syntax with powershell code fence label (was unlabeled CMD syntax). - Update port selection guidance to require checking both the dev port N and its companion HMR port N+1 (derived in vite.config.ts line 17: const hmrPort = devPort + 1), and stay below 65535.
|
| Filename | Overview |
|---|---|
| CONTRIBUTING.md | Docs-only update; all factual claims verified against rust-toolchain.toml, package.json, and scripts/run-dev-win.sh — Rust version, Ninja requirement, dev:app:win command, and OPENHUMAN_DEV_PORT behavior are all accurate. |
Reviews (1): Last reviewed commit: "fix(docs): use PowerShell syntax for LIB..." | Re-trigger Greptile
Summary
rust-toolchain.toml(1.96.1).dev:app:winbootstrap instead of the macOS-onlydev:appscript.OPENHUMAN_DEV_PORToverride and the/utf-8MSVC workaround for non-UTF-8 code pages.Problem
A fresh Windows contributor following
CONTRIBUTING.mdis told to install a stale Rust toolchain and use a macOS-specific desktop command. The guide also omits Ninja, the supported workaround for reserved port1420, and the MSVC UTF-8 workaround described in #5034.Solution
Update the guide against the current source-of-truth files rather than duplicating a lower-level Tauri command. The existing
pnpm dev:app:winpath already configures MSVC, Ninja, CEF, and appliesOPENHUMAN_DEV_PORTto both Vite and Tauri, so the documentation now directs contributors to that maintained entrypoint.Submission Checklist
Closes #5034below.Impact
Documentation only. No desktop, mobile, web, CLI, performance, security, migration, or runtime compatibility behavior changes.
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
docs/5034-windows-contributor-setup567ded7bf0afeb5fb25d5edc1557be4618616f60Validation Run
pnpm --filter openhuman-app format:check— blocked locally; see below.pnpm typecheck— N/A: docs-only change.pnpm docs:check; source-of-truth assertions for Rust version, Windows script, Ninja package ID, and port override; local-link check;git diff --check.Validation Blocked
command: CI=true pnpm --filter openhuman-app format:checkerror: local run exceeded 60 seconds while checking the unchanged app tree; this environment also has no cargo/rustc on PATH for the command's Rust formatting phaseimpact: none on the changed file; generated-doc, source-truth, local-link, and whitespace checks pass for CONTRIBUTING.mdBehavior Changes
Parity Contract
scripts/run-dev-win.shand the root/app package scripts.Duplicate / Superseded PR Handling
Summary by CodeRabbit