[docs] Add a Review section with overview in Home #26064
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
amandeepmittal
changed the title
amandeepmittal
changed the title
|
📘 Your docs preview website is ready! |
brentvatne
requested changes
Mar 2, 2024
Co-authored-by: Brent Vatne <brentvatne@gmail.com>
|
Curious why we went with "Review" as opposed to "Preview". When I think of "Review" in the context of mobile apps, I think of the app store review processes. |
brentvatne
reviewed
Mar 6, 2024
Following the same pattern that we do for naming things as we do on expo.dev/home. Context I had was we avoid using "preview" as a term here. Recently, there was a discussion on Slack thread. |
3 tasks
amandeepmittal
added a commit
that referenced
this pull request
Mar 12, 2024
# Why <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> While going through the guide recently for the Review section (#26064), I found some inconsistencies and missing information. # How <!-- How did you build this feature or fix this bug and why? --> This PR: - Updates introduction to add context on what this guide talks about. - Update step 2 in both sections to make a describe a list of things that the their respective script. - In Step 3, fix formatting by using bold for setting names, fixing settings name - In using Bun as package manager section, add context the same code snippet can also be used in **preview.yml** - Fix typos # 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. --> Run docs locally and visit: http://localhost:3002/eas-update/github-actions/ or see preview: http://docs.expo.dev-pr-27552.s3-website-us-east-1.amazonaws.com/eas-update/github-actions/. # 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.dev and README.md). - [x] Conforms with the [Documentation Writing Style Guide](https://github.com/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).
3 tasks
amandeepmittal
commented
Mar 14, 2024
amandeepmittal
commented
Mar 27, 2024
brentvatne
approved these changes
Mar 29, 2024
amandeepmittal
deleted the
aman/eng-10811-preview-section-in-the-home-tab-of-docs
branch
amandeepmittal
added a commit
that referenced
this pull request
Mar 29, 2024
# Why <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> This came up recently in a conversation with @brentvatne as we do not have a page where we describe how to publish an update and how it works briefly. # How <!-- How did you build this feature or fix this bug and why? --> In the EAS Update section, this PR: - Adds a guide on "How to publish an update" - Updates EAS Update introduction with a BoxLink to the above guide - Updates EAS Update Get started guide by removing the Step 7 which describes the command to publish and test the update and instead add a next to the above guide Other changes: - Rename "Use EAS CLI" doc to "Manage branches and channels with EAS CLI" as the title and description didn't match the contents of the doc. - Rename "Develop faster" doc to "Updates distribution during development" as the title didn't match the contents of the doc. - Use EAS Update logo in BoxLinks - Fix minor verbiage issues - Link from Publish an update guide to Orbit guide in Review section (http://docs.expo.dev-pr-26064.s3-website-us-east-1.amazonaws.com/review/with-orbit/) in #26064 # 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. --> Run docs locally and visit: http://localhost:3002/eas-update/publish/ or see preview: http://docs.expo.dev-pr-27665.s3-website-us-east-1.amazonaws.com/eas-update/publish/. # 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.dev and README.md). - [x] Conforms with the [Documentation Writing Style Guide](https://github.com/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). --------- Co-authored-by: Quinlan Jung <quin@expo.io>
3 tasks
amandeepmittal
added a commit
that referenced
this pull request
Mar 29, 2024
# Why <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> We recently updated Video component to add a border radius as per our styleguide. We also introduced adding a caption at the bottom of a video in #26064. Since the latter PR was created before the former, setting `overflow: hidden` also hides the `caption`. This PR takes `<p>` that is used to display the caption outside of the `<div>` on which `overflow` is used. It also creates wrapper `<div>` to preserve the initial `margin-bottom`. # 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. --> Run docs locally and see http://localhost:3002/review/with-orbit/ (this is the page where we use `caption`). ## Preview  # Checklist <!-- Please check the appropriate items below if they apply to your diff. This is required for changes to Expo modules. --> - [ ] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md). - [ ] Conforms with the [Documentation Writing Style Guide](https://github.com/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
Closes ENG-10811
How
navigation.jsVideocomponent to add a caption (similarly to how we do withImageSpotlight)Test Plan
Run docs locally and visit: http://localhost:3002/review/overview/ or see http://docs.expo.dev-pr-26064.s3-website-us-east-1.amazonaws.com/review/overview/
Checklist
npx expo prebuild& EAS Build (eg: updated a module plugin).