Skip to content

Commit 2a136c7

Browse files
Apply suggestions from code review
Co-authored-by: Michelle Zhang <[email protected]>
1 parent 39ac446 commit 2a136c7

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/product/sentry-toolbar/faq.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ description: "Frequently asked questions about the Sentry Toolbar."
99
Since the Sentry Toolbar will be visible to users within your app, it's important to consider which environments should render it.
1010

1111
If your web application requires authentication to access:
12-
- In development and staging, always initialized the Sentry Toolbar.
13-
- In production conditionally initialize the Sentry Toolbar when an employee is logged in.
12+
- In development and staging, always initialize the Sentry Toolbar.
13+
- In production, conditionally initialize the Sentry Toolbar when an employee is logged in.
1414

1515
If you web application does not require authenticaion:
16-
- In development and staging environments initialize the Toolbar at all times.
16+
- In development and staging environments, initialize the Toolbar at all times.
1717
- In production environments, do not initialize the Toolbar.
1818

1919
Initializing the Sentry Toolbar allows all developers and testers to quickly go from the page they're looking at, back to Sentry for further debugging.
@@ -25,9 +25,9 @@ Once you decide where and when you want the Toolbar to appear, you'll write thos
2525

2626
<Expandable permalink title="How can I conditionally initialize the Toolbar?">
2727

28-
Implementing the specific conditions for initializing the Toolbar will vary from app to app and which ever framework or template library is in use.
28+
Implementing the specific conditions for initializing the Toolbar will vary from app to app and whichever framework or template library is in use.
2929

30-
For example, the conditions to show show the Toolbar in development and staging might look like this, if written in JavaScript:
30+
For example, the conditions to show the Toolbar in development and staging might look like this, if written in JavaScript:
3131

3232
```html {tabTitle:CDN}
3333
<script>

docs/product/sentry-toolbar/setup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ yarn add @sentry/toolbar
3636

3737
## 3. Configure
3838

39-
Finally, whether you have a React application or are loading the Toolbar from the CDN you need to initialize the Toolbar using JavaScript. This will prompt any visitor to login to your Sentry organization.
39+
Finally, whether you have a React application or are loading the Toolbar from the CDN, you need to initialize the Toolbar using JavaScript. This will prompt any visitor to login to your Sentry organization.
4040

4141
```javascript {tabTitle: React}
4242
import {useSentryToolbar} from '@sentry/toolbar';
@@ -120,7 +120,7 @@ useSentryToolbar({
120120

121121
| Options | Type | Description | Default Value |
122122
| ------- | ---- | ----------- | ------------- |
123-
| `enabled` | `booleand (optional)` | Conditionally initialize the toolbar. Set this to false to avoid requesting the toolbar code on the browser, or to safely unmount an existing toolbar instance | `true` |
123+
| `enabled` | `boolean (optional)` | Conditionally initialize the toolbar. Set this to false to avoid requesting the toolbar code on the browser, or to safely unmount an existing toolbar instance | `true` |
124124
| `version` | `string (optional)` | Request a speicifc version of the toolbar from the CDN. It's recommended to use `latest` for automatic updates. See https://github.com/getsentry/sentry-toolbar/releases for a list of available release tags. | `'latest'` |
125125
| `cdn` | `string (optional)` | Overrides the `version` field above. Setting the CDN is useful if you want to self-host a specific version of the Toolbar. | `'https://browser.sentry-cdn.com/sentry-toolbar/latest/toolbar.min.js'` |
126126

@@ -129,7 +129,7 @@ useSentryToolbar({
129129

130130
If you have called `SentryToolbar.init({...})` to render the Toolbar, but now want to manually remove or unmount it from the page, you can call the cleanup function that is returned from `init()`. This will unmount all the injected HTML and CSS. Login credentials will not be removed, so you can re-insert the toolbar and still be authenticated.
131131

132-
If you are using the React hook, then the toolbar will unmount when the react component is unmounted. Or if you set `enabled: false`.
132+
If you are using the React hook, then the toolbar will unmount when the React component is unmounted. Or if you set `enabled: false`.
133133

134134
```javascript
135135
const unmountToolbar = window.SentryToolbar.init({ ... });

0 commit comments

Comments
 (0)