From 42bafeba04958b052af69e0338230a680d15041b Mon Sep 17 00:00:00 2001 From: Aman Mittal Date: Sun, 28 May 2023 17:50:11 +0530 Subject: [PATCH] [docs] Fix android and ios directory names not following styleguide convention (#22670) # Why Some pages where I found that filenames/directories name weren't bold or following writing style guideline. # How By updating the references and apply the writing styleguide convention. # Test Plan Changes have been tested by running docs locally. # Checklist - [ ] 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: Bartosz Kaszubowski --- docs/pages/bare/hello-world.mdx | 2 +- docs/pages/faq.mdx | 9 +++++++-- docs/pages/guides/splash-screens.mdx | 2 +- .../unversioned/sdk/register-root-component.mdx | 10 ++++------ .../versions/v46.0.0/sdk/register-root-component.mdx | 10 ++++------ .../versions/v47.0.0/sdk/register-root-component.mdx | 10 ++++------ .../versions/v48.0.0/sdk/register-root-component.mdx | 10 ++++------ 7 files changed, 25 insertions(+), 28 deletions(-) diff --git a/docs/pages/bare/hello-world.mdx b/docs/pages/bare/hello-world.mdx index 4d715dff16e3b1..5d27ea983c405e 100644 --- a/docs/pages/bare/hello-world.mdx +++ b/docs/pages/bare/hello-world.mdx @@ -7,7 +7,7 @@ description: An overview of bare React Native app with Expo tools. import { BoxLink } from '~/ui/components/BoxLink'; import { Terminal } from '~/ui/components/Snippet'; -A bare React Native app is a project where developers make direct changes to their native `ios` and `android` project directories rather than continuously generating them on demand using the [Expo config (**app.json**) and prebuild](/workflow/prebuild). All tools and services offered by Expo including [EAS](/eas), Expo CLI, and the libraries in the Expo SDK, are built around bare React Native apps. +A bare React Native app is a project where developers make direct changes to their native **android and **ios** project directories rather than continuously generating them on demand using the [Expo config (**app.json**) and prebuild](/workflow/prebuild). All tools and services offered by Expo including [EAS](/eas), Expo CLI, and the libraries in the Expo SDK, are built around bare React Native apps. Before you get started with a React Native app, make sure you set up your environment for [React Native CLI](https://reactnative.dev/docs/environment-setup). diff --git a/docs/pages/faq.mdx b/docs/pages/faq.mdx index 939082405f6a50..c77a4b8c954b97 100644 --- a/docs/pages/faq.mdx +++ b/docs/pages/faq.mdx @@ -4,7 +4,12 @@ description: A list of common questions and limitations about Expo and related s --- import { BoxLink } from '~/ui/components/BoxLink'; -import { BuildIcon, EasMetadataIcon, LayersTwo02Icon, BellRinging04Icon } from '@expo/styleguide-icons'; +import { + BuildIcon, + EasMetadataIcon, + LayersTwo02Icon, + BellRinging04Icon, +} from '@expo/styleguide-icons'; This page lists some of the common questions and answers about Expo and related services. If you have a question that is not answered here, see [ Forums](https://forums.expo.io) for more common questions. @@ -94,7 +99,7 @@ Regardless of which CLI you use, you can use any part of the [Expo SDK](/version ## Is Expo Go open source? -Yes, the source for Expo Go can be found in the [expo/expo GitHub repository](https://github.com/expo/expo) in the `home`, `android`, and `ios` directories. The Expo Go app is also built with Expo and React Native. +Yes, the source for Expo Go can be found in the [expo/expo GitHub repository](https://github.com/expo/expo) in the **home**, **android**, and **ios** directories. The Expo Go app is also built with Expo and React Native. ## Is Expo eject deprecated? diff --git a/docs/pages/guides/splash-screens.mdx b/docs/pages/guides/splash-screens.mdx index 314aedfdc3d760..b9c688110e8b56 100644 --- a/docs/pages/guides/splash-screens.mdx +++ b/docs/pages/guides/splash-screens.mdx @@ -136,7 +136,7 @@ Depending on the `resizeMode` you will get the following behavior: ### Bare workflow apps -If your app does not use [Expo Prebuild](/workflow/prebuild) (formerly the _managed workflow_) to generate the native `ios` and `android` directories, then changes in the [Expo config][expo-config] will have no effect. To setup and customize your splash screen manually, refer to [this guide](https://github.com/expo/expo/tree/main/packages/expo-splash-screen#-installation-in-bare-react-native-projects). +If your app does not use [Expo Prebuild](/workflow/prebuild) (formerly the _managed workflow_) to generate the native **android** and **ios** directories, then changes in the [Expo config][expo-config] will have no effect. To setup and customize your splash screen manually, refer to [this guide](https://github.com/expo/expo/tree/main/packages/expo-splash-screen#-installation-in-bare-react-native-projects). ### iOS Caching diff --git a/docs/pages/versions/unversioned/sdk/register-root-component.mdx b/docs/pages/versions/unversioned/sdk/register-root-component.mdx index 870bcaead30b2d..aa9a688b6b6884 100644 --- a/docs/pages/versions/unversioned/sdk/register-root-component.mdx +++ b/docs/pages/versions/unversioned/sdk/register-root-component.mdx @@ -17,11 +17,9 @@ Sets the initial React component to render natively in the app's root React Nati ### Manual Android setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `android` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **android** directory. -Update the Android `MainActivity.java` file to use the name `"main"` in the `getMainComponentName` function. - -`android/app/src/main//MainActivity.java` +Update the **android/app/src/main/your-package/MainActivity.java** file to use the name `main` in the `getMainComponentName` function. ```diff @Override @@ -32,9 +30,9 @@ Update the Android `MainActivity.java` file to use the name `"main"` in the `get ### Manual iOS setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `ios` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **ios** directory. -Update the iOS `ios//AppDelegate.(m|mm|swift)` file to use the **moduleName** `"main"` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. +Update the iOS **ios/your-name/AppDelegate.(m|mm|swift)** file to use the **moduleName** `main` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. ## API diff --git a/docs/pages/versions/v46.0.0/sdk/register-root-component.mdx b/docs/pages/versions/v46.0.0/sdk/register-root-component.mdx index 47c5f840e3f7e4..7a8ec580e6a7ff 100644 --- a/docs/pages/versions/v46.0.0/sdk/register-root-component.mdx +++ b/docs/pages/versions/v46.0.0/sdk/register-root-component.mdx @@ -17,11 +17,9 @@ Sets the initial React component to render natively in the app's root React Nati ### Manual Android setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `android` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **android** directory. -Update the Android `MainActivity.java` file to use the name `"main"` in the `getMainComponentName` function. - -`android/app/src/main//MainActivity.java` +Update the **android/app/src/main/your-package/MainActivity.java** file to use the name `main` in the `getMainComponentName` function. ```diff @Override @@ -32,9 +30,9 @@ Update the Android `MainActivity.java` file to use the name `"main"` in the `get ### Manual iOS setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `ios` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **ios** directory. -Update the iOS `ios//AppDelegate.(m|mm|swift)` file to use the **moduleName** `"main"` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. +Update the iOS **ios/your-name/AppDelegate.(m|mm|swift)** file to use the **moduleName** `main` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. ## API diff --git a/docs/pages/versions/v47.0.0/sdk/register-root-component.mdx b/docs/pages/versions/v47.0.0/sdk/register-root-component.mdx index c801b9201e6d55..2234a802ba2011 100644 --- a/docs/pages/versions/v47.0.0/sdk/register-root-component.mdx +++ b/docs/pages/versions/v47.0.0/sdk/register-root-component.mdx @@ -17,11 +17,9 @@ Sets the initial React component to render natively in the app's root React Nati ### Manual Android setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `android` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **android** directory. -Update the Android `MainActivity.java` file to use the name `"main"` in the `getMainComponentName` function. - -`android/app/src/main//MainActivity.java` +Update the **android/app/src/main/your-package/MainActivity.java** file to use the name `main` in the `getMainComponentName` function. ```diff @Override @@ -32,9 +30,9 @@ Update the Android `MainActivity.java` file to use the name `"main"` in the `get ### Manual iOS setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `ios` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **ios** directory. -Update the iOS `ios//AppDelegate.(m|mm|swift)` file to use the **moduleName** `"main"` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. +Update the iOS **ios/your-name/AppDelegate.(m|mm|swift)** file to use the **moduleName** `main` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. ## API diff --git a/docs/pages/versions/v48.0.0/sdk/register-root-component.mdx b/docs/pages/versions/v48.0.0/sdk/register-root-component.mdx index dcec9df9d88532..be829128d71a7d 100644 --- a/docs/pages/versions/v48.0.0/sdk/register-root-component.mdx +++ b/docs/pages/versions/v48.0.0/sdk/register-root-component.mdx @@ -17,11 +17,9 @@ Sets the initial React component to render natively in the app's root React Nati ### Manual Android setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `android` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **android** directory. -Update the Android `MainActivity.java` file to use the name `"main"` in the `getMainComponentName` function. - -`android/app/src/main//MainActivity.java` +Update the **android/app/src/main/your-package/MainActivity.java** file to use the name `main` in the `getMainComponentName` function. ```diff @Override @@ -32,9 +30,9 @@ Update the Android `MainActivity.java` file to use the name `"main"` in the `get ### Manual iOS setup -> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the `ios` directory. +> This is only required if your app does **not** use [Expo Prebuild](/workflow/prebuild) to continuously generate the **ios** directory. -Update the iOS `ios//AppDelegate.(m|mm|swift)` file to use the **moduleName** `"main"` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. +Update the iOS **ios/your-name/AppDelegate.(m|mm|swift)** file to use the **moduleName** `main` in the `createRootViewWithBridge:bridge moduleName:@"main" initialProperties:initProps` line of the `application:didFinishLaunchingWithOptions:` function. ## API