Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation assumes I have yarn installed #139

Closed
boek opened this issue Oct 24, 2024 · 4 comments
Closed

Documentation assumes I have yarn installed #139

boek opened this issue Oct 24, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@boek
Copy link
Collaborator

boek commented Oct 24, 2024

To make things easier for people coming to RN from rust we may want to call out installing yarn in the getting started guide.
@Johennes
Copy link
Collaborator

It is mentioned in the pre-install guide actually: https://github.com/jhugman/uniffi-bindgen-react-native/blob/main/docs/src/guides/pre-installation.md?plain=1#L11

Maybe it needs to be repeated in the getting starting guide?

@jhugman
Copy link
Owner

jhugman commented Oct 24, 2024

This is the second time the "Rust to RN" docs have caught people out. Perhaps we need to start from the very basics, with an Install Node and Yarn section.

@jhugman jhugman added the documentation Improvements or additions to documentation label Oct 24, 2024
@boek
Copy link
Collaborator Author

boek commented Oct 24, 2024

🤦 not sure how I missed that.

I pulled that section out into an info which might help people like me not gloss over it.

image

boek added a commit to boek/uniffi-bindgen-react-native that referenced this issue Oct 24, 2024
@boek
For jhugman#139 - Pulls sentence about yarn into an info block
0550c62
boek added a commit that referenced this issue Oct 24, 2024
@boek @Johennes
For #139 - Pulls sentence about yarn into an info block (#142)
0486689 
This patch pulls the sentence about requiring yarn into an info block to
help users not to miss this step.


![image](https://github.com/user-attachments/assets/0b7141fb-ca8d-4765-b485-ed9cc9ca402d)

---------

Co-authored-by: Johannes Marbach <[email protected]>
@jhugman
Copy link
Owner

jhugman commented Oct 24, 2024

Fixed by #142

@jhugman jhugman closed this as completed Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jhugman @Johennes @boek