Skip to content

docs: update README installation steps#44

Merged
gmegidish merged 3 commits into
mobile-next:mainfrom
Rezisn:docs/update-readme-docs
Jun 15, 2026
Merged

docs: update README installation steps#44
gmegidish merged 3 commits into
mobile-next:mainfrom
Rezisn:docs/update-readme-docs

Conversation

@Rezisn

@Rezisn Rezisn commented May 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Clarify xcbeautify as a required dependency for building devicekit-ios.
  • Ensure git submodules are initialized during setup (required for Opus).
  • Updated Quick Start step to include parameters for device.screenshot.

@coderabbitai

coderabbitai Bot commented May 8, 2026

Copy link
Copy Markdown

Walkthrough

The README documentation has been updated in two areas. The "Building from Source" section now includes explicit instructions to install the xcbeautify dependency via Homebrew. In the "Quick Start" section, the example JSON-RPC request for device.screenshot was modified to pass format: "png" as a parameter instead of using an empty parameters object.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description is related to the changeset and mentions the three areas of change, though the actual implementation details may not fully match all stated objectives.
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.
Title check ✅ Passed The PR title 'docs: update README installation steps' directly addresses the main changes documented in the raw summary and PR objectives, which focus on updating README documentation including installation dependencies and Quick Start examples.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@Rezisn Rezisn changed the title docs: update README install steps (xcbeautif and init submodules) docs: update README install steps (xcbeautify and init submodules) May 8, 2026

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 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 `@README.md`:
- Around line 83-86: The description for the device.screenshot example is
inconsistent: the JSON-RPC call sets "format": "jpg" but the text says it
returns a PNG; update the README so they match by either changing the params in
the example (the JSON string for method "device.screenshot" and params "format")
to "png" or change the descriptive sentence to state it returns a base64-encoded
JPEG; ensure references to "device.screenshot" and the "format" param are
updated accordingly.
🪄 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

Run ID: b096ac97-f8d4-41ce-a068-45e5ba36bbc0

📥 Commits

Reviewing files that changed from the base of the PR and between 9562f3a and b5cf1ef.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment thread README.md
curl -X POST http://127.0.0.1:12004/rpc \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{},"id":1}'
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{ "format": "png" },"id":1}'

@Rezisn Rezisn May 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

found that current implementation of device.screenshot (here) set format as mandatory parameters.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@gmegidish

Copy link
Copy Markdown
Member

@Rezisn I cannot merge unless you sign your commits. Can you do that please?

@Rezisn Rezisn force-pushed the docs/update-readme-docs branch from 03bf48e to 676d722 Compare June 15, 2026 09:07
@Rezisn

Rezisn commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

@gmegidish i rewrote the commits to have the signed version, thanks

@Rezisn Rezisn changed the title docs: update README install steps (xcbeautify and init submodules) docs: update README installation steps Jun 15, 2026
@gmegidish gmegidish merged commit 4f7e98c into mobile-next:main Jun 15, 2026
1 check passed
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.

2 participants