Skip to content

docs: fix remote device script names - #569

Open
CooperSheroy wants to merge 1 commit into
wonderwhy-er:mainfrom
CooperSheroy:catalina/remote-device-readme-scripts-20260711
Open

docs: fix remote device script names#569
CooperSheroy wants to merge 1 commit into
wonderwhy-er:mainfrom
CooperSheroy:catalina/remote-device-readme-scripts-20260711

Conversation

@CooperSheroy

@CooperSheroy CooperSheroy commented Jul 11, 2026

Copy link
Copy Markdown

Summary

  • update the remote-device README to reference the existing root device:start:dev script
  • remove the stale direct src/remote-device npm run device instruction, since that folder has no package manifest

Validation

  • npm run build
  • node -e "const pkg=require('./package.json'); for (const name of ['device:start','device:start:dev']) { if (!pkg.scripts?.[name]) throw new Error('Missing script '+name); console.log(name+'='+pkg.scripts[name]); }"

Summary by CodeRabbit

  • Documentation
    • Updated device startup instructions to use the repository’s TypeScript tooling.
    • Clarified the command for starting the device in development and debugging mode.

@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f7d84d57-4741-4b26-a959-966bbc4583bb

📥 Commits

Reviewing files that changed from the base of the PR and between 78100e6 and 6ad3e08.

📒 Files selected for processing (1)
  • src/remote-device/README.md

📝 Walkthrough

Walkthrough

Updated remote-device README startup instructions to use the repository root device script and the current development startup command.

Changes

Remote-device startup documentation

Layer / File(s) Summary
Document repository-level startup commands
src/remote-device/README.md
The README now directs standard startup through the repository root script and documents npm run device:start:dev for development and debugging.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the README docs change to correct remote device script names.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant