-
Notifications
You must be signed in to change notification settings - Fork 29.5k
Add discussion of federated plugin documentation #177659
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
Conversation
Adds a canonical reference for the guidance we give in reviews about how to document platform-specific behaviors in federated plugins, and the reason for that guidance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a 'Documentation' section to the contributing guide for federated plugins. It advises keeping platform-specific documentation within implementation packages and using general language for platform support in shared code to avoid documentation becoming stale. The change is clear and provides good examples. I've suggested fixes for a couple of typos.
bparrishMines
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
flutter/flutter@7cf0dc1...df72035 2025-10-29 engine-flutter-autoroll@skia.org Roll Packages from c8ba0cc to 41c6b3d (3 revisions) (flutter/flutter#177725) 2025-10-29 43054281+camsim99@users.noreply.github.com [Android] Remove unecessary `spy` in `FlutterActivityAndFragmentDelegateTest` (flutter/flutter#177120) 2025-10-29 stuartmorgan@google.com Add discussion of federated plugin documentation (flutter/flutter#177659) 2025-10-29 mdebbar@google.com [web] Deprecate --pwa-strategy (flutter/flutter#177613) 2025-10-29 engine-flutter-autoroll@skia.org Roll Skia from 53b8b802bbc4 to 0a0c9f8c704f (1 revision) (flutter/flutter#177701) 2025-10-29 alex.medinsh@gmail.com Add `Navigator.popUntilWithResult` (flutter/flutter#169341) 2025-10-29 116356835+AbdeMohlbi@users.noreply.github.com Replace deprecated `withOpacity` with `withValues` in `text_style.dart` (flutter/flutter#177537) 2025-10-29 116356835+AbdeMohlbi@users.noreply.github.com Replace deprecated withOpacity in `radio.1.dart` example (flutter/flutter#177606) 2025-10-29 engine-flutter-autoroll@skia.org Roll Skia from 4408d8ea88b0 to 53b8b802bbc4 (2 revisions) (flutter/flutter#177698) 2025-10-29 robert.ancell@canonical.com Remove generated file from template manifest (flutter/flutter#177034) 2025-10-29 engine-flutter-autoroll@skia.org Roll Skia from e582a5594b6f to 4408d8ea88b0 (5 revisions) (flutter/flutter#177691) 2025-10-28 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from ir6J2isKAYa1jNLyJ... to 3EF6k6lqXPWDwrdyj... (flutter/flutter#177682) 2025-10-28 jesswon@google.com [Gradle 9] Fix Engine Deps (flutter/flutter#177623) 2025-10-28 116356835+AbdeMohlbi@users.noreply.github.com Replace deprecated `withOpacity` in `focus_scope.0.dart` example (flutter/flutter#177542) 2025-10-28 bruno.leroux@gmail.com Fix EditableText _justResumed is not accurate (flutter/flutter#177658) 2025-10-28 116356835+AbdeMohlbi@users.noreply.github.com Replace deprecated `withOpacity` in `interactive_viewer.builder.0.dart` (flutter/flutter#177541) 2025-10-28 bruno.leroux@gmail.com Fix TextButton.icon breaks focus traversal and ink effect when toggling icon (flutter/flutter#176579) 2025-10-28 jesswon@google.com [Android 16] Update Engine `ci.yaml` to test against Java 21 (flutter/flutter#177677) 2025-10-28 116356835+AbdeMohlbi@users.noreply.github.com Replace deprecated `withOpacity` in `interactive_viewer.constrained.0.dart` (flutter/flutter#177540) 2025-10-28 116356835+AbdeMohlbi@users.noreply.github.com Replace opacity from random color in navigation bar test (flutter/flutter#177490) 2025-10-28 engine-flutter-autoroll@skia.org Roll Skia from e4d3d8f31aef to e582a5594b6f (6 revisions) (flutter/flutter#177679) 2025-10-28 matej.knopp@gmail.com Workaround for lag when dragging window titlebar on Windows (flutter/flutter#177597) 2025-10-28 engine-flutter-autoroll@skia.org Roll Packages from bbf96a0 to c8ba0cc (2 revisions) (flutter/flutter#177672) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC bmparr@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Adds a canonical reference for the guidance we give in reviews about how to document platform-specific behaviors in federated plugins, and the reason for that guidance. --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Adds a canonical reference for the guidance we give in reviews about how to document platform-specific behaviors in federated plugins, and the reason for that guidance.