From 0778ad7f5145abc60f0bf2d475c48db341f5019b Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Mon, 29 Jun 2026 18:08:28 +0530 Subject: [PATCH 1/8] docs: add Arcade installation walkthrough video to getting started guide --- src/content/docs/getting-started/index.mdx | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 399f9e8e..525b9767 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -12,7 +12,21 @@ import { } from 'starlight-theme-nova/components'; import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; -{/* TODO: Add 2-minute installation walkthrough video */} +{/* ARCADE EMBED START */} +
+ +
+{/* ARCADE EMBED END */} This guide walks you through installing Shorebird and integrating it into your Flutter app. From 59d9e84c1fc42f16ba85e4f2263383092372497c Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Mon, 29 Jun 2026 18:11:36 +0530 Subject: [PATCH 2/8] style: reformat Arcade embed styles for better readability in getting-started documentation --- src/content/docs/getting-started/index.mdx | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 525b9767..fdc4728c 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -13,8 +13,14 @@ import { import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; {/* ARCADE EMBED START */} +
{/* ARCADE EMBED END */} From 44cc19947a2794979dd62e8058619408c97d6bb0 Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Thu, 2 Jul 2026 15:17:11 +0530 Subject: [PATCH 3/8] refactor: replace inline iframe with ArcadeEmbed component in getting-started guide --- src/content/docs/getting-started/index.mdx | 31 ++++------------------ 1 file changed, 5 insertions(+), 26 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index fdc4728c..7bbd11e7 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -11,34 +11,13 @@ import { LinkCard, } from 'starlight-theme-nova/components'; import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; +import ArcadeEmbed from '~/components/ArcadeEmbed.astro'; {/* ARCADE EMBED START */} - -
- -
+ {/* ARCADE EMBED END */} This guide walks you through installing Shorebird and integrating it into your From 0d011feba42ebc3812b2ad06fac1d14e8f9216a2 Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Thu, 2 Jul 2026 15:17:36 +0530 Subject: [PATCH 4/8] docs: add empty line for spacing before ArcadeEmbed in getting-started guide --- src/content/docs/getting-started/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 7bbd11e7..21ddd038 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -14,6 +14,7 @@ import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; import ArcadeEmbed from '~/components/ArcadeEmbed.astro'; {/* ARCADE EMBED START */} + Date: Thu, 2 Jul 2026 17:55:56 +0530 Subject: [PATCH 5/8] docs: add ArcadeEmbed tutorial component to code-push creation guide --- src/content/docs/code-push/create.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/content/docs/code-push/create.mdx b/src/content/docs/code-push/create.mdx index ba9c381b..0532fe90 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 From d3c524ba7f651b059ce1ada48c984163e1c1eeaa Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Thu, 2 Jul 2026 17:58:32 +0530 Subject: [PATCH 6/8] docs: update Arcade embed title in code-push documentation --- src/content/docs/code-push/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/code-push/create.mdx b/src/content/docs/code-push/create.mdx index 0532fe90..78a53f15 100644 --- a/src/content/docs/code-push/create.mdx +++ b/src/content/docs/code-push/create.mdx @@ -23,7 +23,7 @@ shorebird create my_app This does several things: From bbb86ed77b281a91f6dd9d49fb06ddf07b52b554 Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Thu, 2 Jul 2026 18:27:29 +0530 Subject: [PATCH 7/8] docs: remove comment wrappers from Arcade embed in getting started guide --- src/content/docs/getting-started/index.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 21ddd038..4248584f 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -13,13 +13,10 @@ import { import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; import ArcadeEmbed from '~/components/ArcadeEmbed.astro'; -{/* ARCADE EMBED START */} - -{/* ARCADE EMBED END */} This guide walks you through installing Shorebird and integrating it into your Flutter app. From d8cb1ea75b89d5a9e124d36fef1d4e980ad76c7b Mon Sep 17 00:00:00 2001 From: Abhishek Doshi Date: Wed, 29 Jul 2026 13:42:45 +0530 Subject: [PATCH 8/8] docs: reposition Arcade embeds for improved documentation layout --- src/content/docs/account/api-keys.mdx | 10 +++++----- src/content/docs/code-push/ci/_authentication.mdx | 10 +++++----- src/content/docs/code-push/index.mdx | 14 +++++++------- 3 files changed, 17 insertions(+), 17 deletions(-) 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/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