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.

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

docs: add Dart/Flutter library setup documentation #899

Merged
merged 29 commits into from
Dec 23, 2022
Merged

docs: add Dart/Flutter library setup documentation #899

merged 29 commits into from
Dec 23, 2022

Conversation

GregoryConrad
Copy link
Contributor

Fixes #845

@welcome
Copy link

welcome bot commented Dec 15, 2022

Hi! Thanks for opening this pull request! 😄

@fzyzcjy
Copy link
Owner

fzyzcjy commented Dec 15, 2022

Good job, looking forward to it!

@GregoryConrad
Copy link
Contributor Author

GregoryConrad commented Dec 20, 2022

Hi, this PR is getting pretty close to done (just have a few pages left to write), so if you want to take a quick first look at the PR (since it is getting pretty massive), thoughts/recommendations would be welcome!

Here's what I have left to write before I would consider this PR done:

  • library.md
  • dart_only.md
  • flutter_wrapper.md
  • melos.md

@GregoryConrad
Copy link
Contributor Author

In the future, it'd probably be a good idea for someone to make a mason brick to simplify the process of creating a library with FRB. A lot of the setup instructions documented here are boilerplate, but some also talk about how/why things work the way they do.

@GregoryConrad GregoryConrad marked this pull request as ready for review December 22, 2022 18:11
@GregoryConrad
Copy link
Contributor Author

@fzyzcjy Ready for review!

@fzyzcjy
Copy link
Owner

fzyzcjy commented Dec 22, 2022

In the future, it'd probably be a good idea for someone to make a mason brick to simplify the process of creating a library with FRB. A lot of the setup instructions documented here are boilerplate, but some also talk about how/why things work the way they do.

IIRC @Desdaemon has made a brick for the non-library case btw

@fzyzcjy Ready for review!

Reviewing!

Copy link
Owner

@fzyzcjy fzyzcjy left a comment

Choose a reason for hiding this comment

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

Great job - this documentation is quite elaborated! Only a few nits and ready to merge :)

book/src/library.md Outdated Show resolved Hide resolved
book/src/library/overview.md Outdated Show resolved Hide resolved
book/src/library/melos.md Outdated Show resolved Hide resolved
book/src/library/flutter_wrapper.md Show resolved Hide resolved
@fzyzcjy
Copy link
Owner

fzyzcjy commented Dec 23, 2022

@all-contributors please add @GregoryConrad for doc

@allcontributors
Copy link
Contributor

@fzyzcjy

I've put up a pull request to add @GregoryConrad! 🎉

@fzyzcjy
Copy link
Owner

fzyzcjy commented Dec 23, 2022

@all-contributors please add @GregoryConrad for code

(given that there are quite a bit of scripts in the doc - IMHO they should be categorized as code)

@allcontributors
Copy link
Contributor

@fzyzcjy

I've put up a pull request to add @GregoryConrad! 🎉

@fzyzcjy fzyzcjy merged commit ab3d21b into fzyzcjy:master Dec 23, 2022
1 check passed
@welcome
Copy link

welcome bot commented Dec 23, 2022

Hi! Congrats on merging your first pull request! 🎉

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain how to create a Flutter package with Rust (instead of an app)
2 participants