docs(getting-started): revamp guides with CLI-first approach#211
Merged
docs(getting-started): revamp guides with CLI-first approach#211
Conversation
thymikee
reviewed
Jan 21, 2026
thymikee
reviewed
Jan 21, 2026
thymikee
reviewed
Jan 21, 2026
thymikee
reviewed
Jan 21, 2026
thymikee
reviewed
Jan 21, 2026
thymikee
reviewed
Jan 21, 2026
| 2. Drag these files into your native iOS app's Xcode project: | ||
| - **`hermesvm.xcframework`** - JavaScript runtime | ||
| - **`ReactBrownfield.xcframework`** - React Native Brownfield library | ||
| - **`<framework_target_name>.xcframework`** - Your framework |
Member
There was a problem hiding this comment.
do we want to hint users into Brownie here?
thymikee
requested changes
Jan 21, 2026
Member
thymikee
left a comment
thymikee
left a comment
There was a problem hiding this comment.
This is mostly good! Missing Expo instructions, and (possibly separately) based on that we should also update the README. Left a few improvements, mostly around the commands, because AFAIK we should use npx brownfield as a shorthand
- Split quick-start into platform-specific iOS and Android guides - Add detailed step-by-step instructions for XCFramework and AAR packaging - Explain brownfield CLI purpose and benefits - Add Xcode/Android Studio screenshots from Rock docs - Remove Rock references, focus on built-in CLI - Add bold highlights for key terms and commands
thymikee
force-pushed
the
oskar/docs-getting-started-revamp
branch
from
ee2fc17 to
5ce0513
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
quick-start.mdx- Simplified to installation + CLI explanation with benefitsios.mdx(new) - Detailed 8-step guide for XCFramework packaging and integrationandroid.mdx(new) - Detailed 10-step guide for AAR packaging and integration_meta.json- Updated navigation orderexamples.mdx- Fixed typopublic/images/- Added 6 screenshots from Rock docsMotivation
Previous docs had multiple paths (CLI, Rock, custom scripts) which was confusing. This PR consolidates around the built-in CLI for a clearer onboarding experience.
All of the integration guides were taken from Rock JS docs. Shoutout to @thymikee for creating them. (https://www.rockjs.dev/docs/brownfield/ios)