[google_maps_flutter] Federate READMEs#11790
Open
stuartmorgan-g wants to merge 6 commits into
Open
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation across multiple Google Maps Flutter packages to centralize platform-specific setup instructions. Instead of duplicating detailed setup steps in the main package README, it now links directly to the platform-specific implementation packages (Android, iOS, and Web) and adds the corresponding setup guides to their respective README files. Feedback is provided regarding the formatting of the documentation, including correcting the indentation of nested code blocks in the Web README, aligning XML attributes in the Android README, and suggesting direct anchor links for the iOS setup sections.
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
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.
Moves the platform-specific setup logic and discussion from the main README to the platform READMEs, per our current best practice.
As part of the move, I simplified the discussion of the iOS implementation package choice somewhat, since I realized there was too much explanation of why things are the way they are, rather than on the steps a client should take.
There's a repeated example code block across the iOS packages now, but I think duplicating that is much better than being inconsistent about where setup info is (or worse, pointing them to one implementation package that's not the same as the one they are using).
Part of flutter/flutter#182772
Pre-Review Checklist
[shared_preferences]///).Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2