diff --git a/src/content/docs/account/api-keys.mdx b/src/content/docs/account/api-keys.mdx index ffd66c60..62219434 100644 --- a/src/content/docs/account/api-keys.mdx +++ b/src/content/docs/account/api-keys.mdx @@ -13,6 +13,11 @@ environments. You can create, view, and revoke API keys from the ## Creating an 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"). @@ -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. - - ## Using an API key Set the key as the `SHOREBIRD_TOKEN` environment variable in your CI platform. diff --git a/src/content/docs/code-push/ci/_authentication.mdx b/src/content/docs/code-push/ci/_authentication.mdx index b1ad3dfe..9168945f 100644 --- a/src/content/docs/code-push/ci/_authentication.mdx +++ b/src/content/docs/code-push/ci/_authentication.mdx @@ -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): + + 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. - - Use this key as your `SHOREBIRD_TOKEN` in CI. The environment variable name is unchanged from previous versions. diff --git a/src/content/docs/code-push/create.mdx b/src/content/docs/code-push/create.mdx index ba9c381b..78a53f15 100644 --- a/src/content/docs/code-push/create.mdx +++ b/src/content/docs/code-push/create.mdx @@ -6,6 +6,8 @@ sidebar: order: 2 --- +import ArcadeEmbed from '~/components/ArcadeEmbed.astro'; + :::note If you have an existing project, you can use @@ -19,6 +21,11 @@ To create a new Flutter project with Shorebird, use `shorebird create`: shorebird create my_app ``` + + This does several things: 1. Runs diff --git a/src/content/docs/code-push/index.mdx b/src/content/docs/code-push/index.mdx index e26c507f..e821bc9c 100644 --- a/src/content/docs/code-push/index.mdx +++ b/src/content/docs/code-push/index.mdx @@ -8,6 +8,13 @@ sidebar: import ArcadeEmbed from '~/components/ArcadeEmbed.astro'; +For a quick overview, check out the demo below. + + + ## What is Code Push? Code Push is a tool that allows you to update your Flutter app instantly over @@ -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. - - - ### Platform feature support matrix Below is a summary of feature support status across all Shorebird target