[docs] Update Safe areas guide for default template #30328
Merged
Conversation
This file contains 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
|
📘 Your docspreview websiteis ready! |
|
I've updated the doc to clarify some confusing/vague parts. Also, used Create a project doc link to link the default template context. It wasn't clear by going to the default template GitHub link as to where this library is coming from. Last update made to this guide was about removing the collapsible to add installation instructions as an alternate directly under the installation section. |
alanjhughes
pushed a commit
that referenced
this pull request
Jul 17, 2024
# Why <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> Part of on-going improvements for docs under Develop section. # How <!-- How did you build this feature or fix this bug and why? --> This PR updates the Safe Areas guide to include - Explain concisely about using safe areas - Update installation section to mention different Expo template behavior and provide installation instructions accordingly - Update Usage section to add steps - Update `useSafeAreaInsets` hook section to include a code example - Add Additional information section to group minimal example, React Navigation usage info, and web usage info - Fix link in the web usage section to point towards the correct usage info for `SafeAreaProvider - Improve overall verbiage of the doc. # Test Plan <!-- Please describe how you tested this change and how a reviewer could reproduce your test, especially if this PR does not include automated tests! If possible, please also provide terminal output and/or screenshots demonstrating your test/reproduction. --> By running docs locally and visiting: http://localhost:3002/develop/user-interface/safe-areas or see Preview: http://docs.expo.dev-pr-30328.s3-website-us-east-1.amazonaws /develop/user-interface/safe-areas/. # Checklist <!-- Please check the appropriate items below if they apply to your diff. This is required for changes to Expo modules. --> - [x] Documentation is up to date to reflect these changes (eg: https://docs.expo.devand README.md). - [x] Conforms with the [Documentation Writing Style Guide](https://github /expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md) - [ ] This diff will work correctly for `npx expo prebuild` & EAS Build (eg: updated a module plugin).
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.
Why
Part of on-going improvements for docs under Develop section.
How
This PR updates the Safe Areas guide to include
useSafeAreaInsetshook section to include a code exampleTest Plan
By running docs locally and visiting:http://localhost:3002/develop/user-interface/safe-areasor see Preview:http://docs.expo.dev-pr-30328.s3-website-us-east-1.amazonaws /develop/user-interface/safe-areas/.
Checklist
npx expo prebuild& EAS Build (eg: updated a module plugin).