Skip to content

Commit 3ba0757

Browse files
authored
ref(astro): Improve Getting Started introduction (#8685)
1 parent fb02718 commit 3ba0757

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed
Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
We recommend installing the SDK by using the `astro` CLI:
1+
Install the SDK by using the `astro` CLI:
22

3-
```bash
3+
```bash {tabTitle:npm}
44
npx astro add @sentry/astro
55
```
66

7+
```bash {tabTitle:yarn}
8+
yarn astro add @sentry/astro
9+
```
10+
11+
```bash {tabTitle:pnpm}
12+
pnpm astro add @sentry/astro
13+
```
14+
715
The `astro` CLI installs the SDK package and adds the Sentry integration to your `astro.config.mjs` file.
816

917
To finish the setup, configure the Sentry integration.
Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Sentry's Astro SDK enables automatic reporting of errors and performance data.
1+
Sentry's Astro SDK enables automatic reporting of errors and performance data in your Astro application.
2+
Our Astro integration instruments both the client as well as the server side of your Astro application.
3+
This page walks you through adding Sentry to your Astro project, configuring it, adding readable stack traces, and verifying your setup.
24

35
<Alert>
46

@@ -7,8 +9,13 @@ Please report any issues you encounter in our [Github Repository](https://github
79

810
</Alert>
911

10-
## Compatibility
12+
## Prerequisites
1113

12-
The minimum supported Astro version is `3.0.0`.
13-
This SDK currently only works on Node runtimes.
14-
Non-Node runtimes, like Vercel's Edge runtime or Cloudflare Pages, are currently not supported.
14+
Before we get started, make sure you have the following:
15+
16+
- A Sentry account.
17+
- Don't have an account yet? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
18+
- An Astro project that uses Astro `3.0.0` or newer.
19+
- A Node runtime:
20+
- This SDK currently only works on Node runtimes (e.g. Node adapter, Vercel with Lambda functions).
21+
Non-Node runtimes, like Vercel's Edge runtime or Cloudflare Pages, are currently not supported.

src/platforms/javascript/common/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
<PlatformContent includePath="getting-started-primer" />
22

3+
<PlatformSection notSupported={["javascript.astro"]}>
4+
35
On this page, we get you up and running with Sentry's SDK.
46

7+
</PlatformSection>
8+
59
<PlatformSection noGuides>
610

711
<Alert level="info" title="Using a framework?">

0 commit comments

Comments
 (0)