Skip to content

feat: Adding documentation about the customizations done in the repo by Shorebird #50

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

Closed

Conversation

erickzanardo
Copy link

I had this internal note which were helping me navigate through the changes that we made in flutter tools, thought it could be interesting to put a PR with it so more people could benefit from them.

@@ -26,6 +26,7 @@ open source.
* [Flutter documentation](https://docs.flutter.dev/)
* [Development wiki](https://github.com/flutter/flutter/wiki)
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
* [Shorebird's customizations](./shorebird.md)
Copy link

Choose a reason for hiding this comment

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

In our other repos we have a shorebird/ dir and then docs/ inside that. Or just README.md inside that. This is also find though. 🤷

@@ -0,0 +1,48 @@
# Shorebird's change in the Flutter Repo 🐦

Choose a reason for hiding this comment

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

Would be nice to move this to either our docs site or _shorebird in the docs directory in order to keep our docs co-located. I worry that we'll lose track of all the places where we have docs otherwise 🤷

Copy link
Author

Choose a reason for hiding this comment

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

Agreed! I added a PR there and will close this one.

@erickzanardo
Copy link
Author

Closing this in favor of Felix's comment: #50 (comment)

@erickzanardo erickzanardo deleted the docs/adding-docs-about-our-changes branch May 22, 2024 13:51
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.

3 participants