Skip to content

Commit

Permalink
[docs] Fix vale warning in Build reference troubleshooting guide (#29147
Browse files Browse the repository at this point in the history
)

# Why

<!--
Please describe the motivation for this PR, and link to relevant GitHub
issues, forums posts, or feature requests.
-->

Add an MDX comment to ignore Vale to lint a specific paragraph. This
paragraph contains an error message which throws vale rule warning to
avoid first person voice.

# 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 `yarn run lint-prose` locally.

# 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).
  • Loading branch information
amandeepmittal authored and pull[bot] committed Oct 21, 2024
1 parent d0c0213 commit 06176b7
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/pages/build-reference/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ All standard advice around [narrowing down the source of an error](https://expo.

Before you go further, you need to be sure that you have located the error message and read it. How you do this will be different depending on whether you're investigating a build failure or runtime error.

{/* <!-- vale off --> */}

### Runtime errors

Common questions that fall under this category are: "my app runs well locally but crashes immediately when I run a build" or "my app works in Expo Go but hangs on the splash screen in my build". When your app builds successfully but crashes or hangs when you run it, this is considered a runtime error.
Expand All @@ -28,6 +30,8 @@ Refer to the ["Production errors" section of the debugging guide](/debugging/run

If can't find any useful information through this approach, try [narrowing down the source of the crash step by step](https://expo.fyi/manual-debugging).

{/* <!-- vale on --> */}

### Build errors

Go to your build details page (find it on the [build dashboard](https://expo.dev/accounts/[account]/projects/[project]/builds) if you don't have it open already) and expand any failed build phases by clicking on them. Often, the earliest phase with errors will contain the most useful information and any subsequent failed phase will have cascaded from the first.
Expand Down

0 comments on commit 06176b7

Please sign in to comment.