Skip to content
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

[docs] Update expo-dev-client and EAS Update guide to add info about Extensions tab #27772

Conversation

amandeepmittal
Copy link
Member

@amandeepmittal amandeepmittal commented Mar 20, 2024

Why

Closes ENG-11705

How

This PR updates the Use expo-dev-client with EAS Update guide by:

  • Adding info on what Extensions tab is and how it can be used to preview an update in a development build
  • Move the Construct a specific URL into its own section
  • Update introduction to match the contents of the guide and explain what this guide does for the reader
  • Change title of "More" section to "Example" since it only provides a link to the GitHub example
  • Change the title of this doc to "Load a published update with expo-dev-client and EAS Update" to match the contents of the guide
  • Link to publish update guide from [docs] Add publish an update guide and other changes #27665 when it mentions about publishing an update
  • Update BoxLink description to use inline code syntax highlight for the library name

Test Plan

Run docs locally and visit: http://localhost:3002/eas-update/expo-dev-client/ or see Preview: http://docs.expo.dev-pr-27772.s3-website-us-east-1.amazonaws.com/eas-update/expo-dev-client/.

Checklist

Copy link

linear bot commented Mar 20, 2024

@expo-bot expo-bot added the bot: passed checks ExpoBot has nothing to complain about label Mar 20, 2024
@expo-bot
Copy link
Collaborator

expo-bot commented Mar 20, 2024

📘 Your docs preview website is ready!

docs/pages/eas-update/expo-dev-client.mdx Outdated Show resolved Hide resolved
docs/pages/eas-update/expo-dev-client.mdx Outdated Show resolved Hide resolved

```bash
exp+[project-slug]://expo-development-client/?url=[https://u.expo.dev/project-id]?channel-name=[channel]

# Example
exp+form-duo://expo-development-client/?url=https://u.expo.dev/675cb1f0-fa3c-11e8-ac99-6374d9643cb2?channel-name=preview
exp+my-app://expo-development-client/?url=https://u.expo.dev/675cb1f0-fa3c-11e8-ac99-6374d9643cb2?channel-name=preview
Copy link
Member

@quinlanj quinlanj Mar 21, 2024

Choose a reason for hiding this comment

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

This example will construct a URL to show the latest update mapped by the preview channel. There's a bunch of different usecases you can build based on our www routes. Might also be worth saying you can get the update preview from the website like here . @jonsamp is currently working to revamp that page, where we'll want to eventually show you a preview QR for a single update group instead of the platform-specific QR we have right now. So we are eventually going to show something like exp+my-slug://u.expo.dev/:appId/group/:groupId. For context, the update group id can be obtained from the website here:
Screenshot 2024-03-21 at 1 04 49 PM

Copy link
Member Author

Choose a reason for hiding this comment

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

This example will construct a URL to show the latest update mapped by the preview channel.

Thanks for catching that! I've fixed it by changing it to development. In the table below, we're also explaining that the channel name is development.

here's a bunch of different usecases you can build based on our www routes.

Should we explain those use cases here?

Might also be worth saying you can get the update preview from the website like here .

Since we do not cover those steps, I've added a section for this:

CleanShot 2024-03-26 at 20 55 59@2x

@jonsamp is currently working to revamp that page, where we'll want to eventually show you a preview QR for a single update group instead of the platform-specific QR we have right now. So we are eventually going to show something like exp+my-slug://u.expo.dev/:appId/group/:groupId. For context, the update group id can be obtained from the website here:

Shall I wait for Jon to revamp this page to add those instructions on this page? I can create a follow up task for this.

Copy link
Member

@quinlanj quinlanj Mar 26, 2024

Choose a reason for hiding this comment

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

Should we explain those use cases here?

No need, just wanted to float the www routes as an fyi (very few people know of it's existence)!

Your revisions look good, thank you!

@quinlanj quinlanj self-requested a review March 21, 2024 20:08
@amandeepmittal amandeepmittal merged commit ebf9a51 into main Mar 31, 2024
5 checks passed
@amandeepmittal amandeepmittal deleted the aman/eng-11705-documentation-needed-for-understanding-the-updates-extension branch March 31, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: passed checks ExpoBot has nothing to complain about preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants