Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/content/docs/account/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ environments. You can create, view, and revoke API keys from the

## Creating an API key

<ArcadeEmbed
src="https://demo.arcade.software/TQUMnX2QwuCRzEV1e8kN?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Create Shorebird API Key"
/>

1. Open **Account → API Keys** in the console.
2. Click **Create API Key**.
3. Enter a descriptive name (e.g., "GitHub Actions — my-app").
Expand All @@ -23,11 +28,6 @@ environments. You can create, view, and revoke API keys from the
The full key value is shown exactly once after creation. Copy it and store it
securely — it cannot be retrieved again.

<ArcadeEmbed
src="https://demo.arcade.software/TQUMnX2QwuCRzEV1e8kN?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Create Shorebird API Key"
/>

## Using an API key

Set the key as the `SHOREBIRD_TOKEN` environment variable in your CI platform.
Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/code-push/ci/_authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Most Shorebird functionality, like creating releases and patches, requires
authentication. To authenticate in your CI, create an API key from the
[Shorebird Console](https://console.shorebird.dev):

<ArcadeEmbed
src="https://demo.arcade.software/TQUMnX2QwuCRzEV1e8kN?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Create Shorebird API Key"
/>

1. Go to **Account → API Keys**.
2. Click **Create API Key**.
3. Give the key a name (e.g., "GitHub Actions — my-app"), choose an expiration,
and select a permission level.
4. Copy the key value — it is only shown once.

<ArcadeEmbed
src="https://demo.arcade.software/TQUMnX2QwuCRzEV1e8kN?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Create Shorebird API Key"
/>

Use this key as your `SHOREBIRD_TOKEN` in CI. The environment variable name is
unchanged from previous versions.

Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/code-push/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sidebar:
order: 2
---

import ArcadeEmbed from '~/components/ArcadeEmbed.astro';

:::note

If you have an existing project, you can use
Expand All @@ -19,6 +21,11 @@ To create a new Flutter project with Shorebird, use `shorebird create`:
shorebird create my_app
```

<ArcadeEmbed
src="https://app.arcade.software/share/eTUuhVp2OJkmg4vRGnRD"
title="Create a new flutter project with Shorebird"
/>

This does several things:

1. Runs
Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/code-push/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ sidebar:

import ArcadeEmbed from '~/components/ArcadeEmbed.astro';

For a quick overview, check out the demo below.

<ArcadeEmbed
src="https://demo.arcade.software/x5ifkvJ8yFZh63hYJF0g?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Send over the air updates to Flutter app"
/>

## What is Code Push?

Code Push is a tool that allows you to update your Flutter app instantly over
Expand Down Expand Up @@ -58,13 +65,6 @@ A typical Code Push workflow looks like this:
1. That's it. Your users will see the update the next time they restart your
app.

For a quick overview, check out the demo below.

<ArcadeEmbed
src="https://demo.arcade.software/x5ifkvJ8yFZh63hYJF0g?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
title="Send over the air updates to Flutter app"
/>

### Platform feature support matrix

Below is a summary of feature support status across all Shorebird target
Expand Down
Loading