fix: get the callouts working again (#351)

Author: tomarra

src/content/docs/Code Push/Continuous Integration/_authentication.mdx

@@ -36,5 +36,9 @@ export SHOREBIRD_TOKEN="$SHOREBIRD_TOKEN" && shorebird patch android
 
 {/* cSpell:enable */}
 
-:::caution The `SHOREBIRD_TOKEN` is a secret and should not be checked in to
-your source control or shared publicly. :::
+:::caution
+
+The `SHOREBIRD_TOKEN` is a secret and should not be checked in to your source
+control or shared publicly.
+
+:::

src/content/docs/Code Push/Continuous Integration/fastlane.mdx

@@ -55,7 +55,6 @@ To run this, execute the following command:
 bundle exec fastlane release_shorebird
 ```
 
-{/* prettier-ignore */}
 :::note
 
 To upload to TestFlight, you will need to create an Apple app-specific password.

src/content/docs/Code Push/Continuous Integration/github.mdx

@@ -19,7 +19,6 @@ Action allows you to integrate Shorebird into your existing GitHub Workflows.
 
 ✅ You are logged into a Shorebird account.
 
-{/* prettier-ignore */}
 :::note
 
 Refer to the [getting started](/) instructions for more information.
@@ -134,7 +133,9 @@ jobs:
           platform: android # or 'ios'
 ```
 
-:::tip The `shorebird-release` action also outputs the release version:
+:::tip
+
+The `shorebird-release` action also outputs the release version:
 
 ```yaml
 - name: 🚀 Shorebird Release
@@ -191,7 +192,9 @@ jobs:
           platform: android # or 'ios'
 ```
 
-:::tip The `shorebird-patch` action also outputs the patch number:
+:::
+
+tip The `shorebird-patch` action also outputs the patch number:
 
 ```yaml
 - name: 🚀 Shorebird Patch

src/content/docs/Code Push/Guides/Flavors/android.mdx

@@ -18,9 +18,13 @@ instructions for more information.
 
 ## Create a Project
 
-:::note In this guide, we'll go through the process of creating a new project
-from scratch. To apply these changes to an existing project, skip this step and
-read ahead. :::
+:::note
+
+In this guide, we'll go through the process of creating a new project from
+scratch. To apply these changes to an existing project, skip this step and read
+ahead.
+
+:::
 
 Create a new project using `flutter create flavors`.
 
@@ -60,8 +64,12 @@ Lastly, edit `android/app/src/main/AndroidManifest.xml` to use the
 +  <application android:label="${applicationLabel}" android:name="${applicationName}" android:icon="@mipmap/ic_launcher">
 ```
 
-:::note To learn more about configuring `productFlavors` refer to the
+{/* prettier-ignore */}
+:::note
+
+To learn more about configuring `productFlavors` refer to the
 [Android Developer documentation](https://developer.android.com/build/build-variants#product-flavors).
+
 :::
 
 ## Initialize Shorebird
@@ -184,7 +192,11 @@ class MyApp extends StatelessWidget {
 }
 ```
 
-:::note Typically `shorebird patch` should be used to fix critical bugs. :::
+:::note
+
+Typically `shorebird patch` should be used to fix critical bugs.
+
+:::
 
 Now that we've applied the changes, let's patch the `internal` variant:
 
@@ -196,8 +208,12 @@ We can validate the patch by visiting
 [Shorebird console](https://console.shorebird.dev/) then select the internal
 release or re-launching the internal release.
 
-:::note If you are testing locally, you don't need to re-run `shorebird preview`
-– just re-launch the app from the device or emulator directly. :::
+:::note
+
+If you are testing locally, you don't need to re-run `shorebird preview` – just
+re-launch the app from the device or emulator directly.
+
+:::
 
 The first time the app is re-launched, we should still see the purple theme and
 shorebird will detect and install the patch in the background. Kill and

src/content/docs/Code Push/Guides/Flavors/ios.mdx

@@ -21,9 +21,13 @@ instructions for more information.
 
 ## Create a Project
 
-:::note In this guide, we'll go through the process of creating a new project
-from scratch. To apply these changes to an existing project, skip this step and
-read ahead. :::
+:::note
+
+In this guide, we'll go through the process of creating a new project from
+scratch. To apply these changes to an existing project, skip this step and read
+ahead.
+
+:::
 
 Create a new project using `flutter create flavors`.
 
@@ -59,8 +63,12 @@ flavors:
 Since the project contains flavors, `shorebird init` generates an app per
 flavor.
 
-:::tip You can view your apps at
-[console.shorebird.dev](https://console.shorebird.dev). :::
+:::tip
+
+You can view your apps at
+[console.shorebird.dev](https://console.shorebird.dev).
+
+:::
 
 ## Create a release
 
@@ -164,8 +172,12 @@ We can validate the patch by visiting
 [Shorebird console](https://console.shorebird.dev/) then select the internal
 release or re-launching the internal release.
 
-:::note If you are testing locally, you don't need to re-run `shorebird preview`
--- just re-launch the app from the device or emulator directly. :::
+:::note
+
+If you are testing locally, you don't need to re-run `shorebird preview` -- just
+re-launch the app from the device or emulator directly.
+
+:::
 
 The first time the app is re-launched, we should still see the purple theme and
 Shorebird will detect and install the patch in the background. Kill and

src/content/docs/Code Push/Guides/Hybrid Apps/android.mdx

@@ -9,8 +9,12 @@ sidebar:
 This guide explains how to use Shorebird in an Android hybrid app scenario (that
 is, your app embeds Flutter UI in non-Flutter UI).
 
-:::note If your app is a pure Flutter app, follow the
-[standard code push guide](/code-push/initialize) instead. :::
+:::note
+
+If your app is a pure Flutter app, follow the
+[standard code push guide](/code-push/initialize) instead.
+
+:::
 
 ## Prerequisites
 
@@ -44,19 +48,27 @@ The `release-version` parameter needs to match the version of the Android app
 that uses this module (i.e., `versionName+versionCode` from the app's
 `app/build.gradle` file).
 
-:::note Because Shorebird only works with release builds, this will only produce
-a release version of your archive. This is similar to running
-`flutter build aar --no-debug --no-profile`. :::
+:::note
+
+Because Shorebird only works with release builds, this will only produce a
+release version of your archive. This is similar to running
+`flutter build aar --no-debug --no-profile`.
 
-:::note This command creates an `aar` with a build number of `1.0`. As with the
+:::
+
+:::note
+
+This command creates an `aar` with a build number of `1.0`. As with the
 `flutter build aar` command, you may optionally provide a different build number
 using the `--build-number` argument, although this is not necessary. The build
 number is used to identify the Flutter module in your app's `build.gradle` file,
 as you can see
 [below](#update-your-android-app-to-use-this-version-of-the-flutter-module).
 
 Shorebird does not use the build number, but **it should remain consistent
-between a release and patches to that release**. :::
+between a release and patches to that release**.
+
+:::
 
 ## Update your Android app to use the `download.shorebird.dev` Maven repository
 
@@ -81,12 +93,15 @@ dependencyResolutionManagement {
 }
 ```
 
-:::note Even though we are replacing
-https://storage.googleapis.com/download.flutter.io. with
-https://download.shorebird.dev/download.flutter.io, any Flutter dependencies
-that are not unique to Shorebird will still be downloaded from
+:::note
+
+Even though we are replacing https://storage.googleapis.com/download.flutter.io.
+with https://download.shorebird.dev/download.flutter.io, any Flutter
+dependencies that are not unique to Shorebird will still be downloaded from
 https://storage.googleapis.com/download.flutter.io. This will only work for
-versions of Flutter that Shorebird supports. :::
+versions of Flutter that Shorebird supports.
+
+:::
 
 ## Update your Android app to use this version of the Flutter module
 
@@ -124,8 +139,12 @@ the lower left corner of Android Studio. Then select "release" from the "Active
 Build Variant" dropdown.
 ![Screenshot 2023-10-06 at 1 15 14 PM](https://github.com/shorebirdtech/docs/assets/581764/91b68c2c-7cee-44f1-a78a-eec443c353a3)
 
-:::warning Attempting to build with a non-release build variant will not be able
-to resolve Flutter symbols in your app. :::
+:::warning
+
+Attempting to build with a non-release build variant will not be able to resolve
+Flutter symbols in your app.
+
+:::
 
 ## Submit your app to the Play Store
 
@@ -141,9 +160,13 @@ Make an edit to the code in your Flutter module. Then run:
 shorebird patch aar --release-version 1.2.3+1
 ```
 
-:::note If you provided a build number to the `shorebird release aar` command
-using the `--build-number` argument, you must also provide that same build
-number to the `shorebird patch aar` command. :::
+:::note
+
+If you provided a build number to the `shorebird release aar` command using the
+`--build-number` argument, you must also provide that same build number to the
+`shorebird patch aar` command.
+
+:::
 
 As with the `release` command, the release version should be the version of the
 Android app that uses this module.

src/content/docs/Code Push/Guides/Hybrid Apps/ios.mdx

@@ -9,8 +9,12 @@ sidebar:
 This guide explains how to use Shorebird in an iOS hybrid app scenario (that is,
 your app embeds Flutter UI in non-Flutter UI).
 
-:::note If your app is a pure Flutter app, follow the
-[standard code push guide](/code-push/initialize) instead. :::
+:::note
+
+If your app is a pure Flutter app, follow the
+[standard code push guide](/code-push/initialize) instead.
+
+:::
 
 ## Prerequisites
 
@@ -58,25 +62,37 @@ The `ShorebirdFlutter.xcframework` and `App.xcframework` artifacts produced by
 the `shorebird release` command will be placed in the `release` directory in the
 root of your Flutter module.
 
-:::note Because Shorebird only works with release builds, this will only produce
-a release version of your archive. This is similar to running
-`flutter build ios-framework --no-debug --no-profile`. :::
+:::note
+
+Because Shorebird only works with release builds, this will only produce a
+release version of your archive. This is similar to running
+`flutter build ios-framework --no-debug --no-profile`.
+
+:::
 
 ## Embed the Flutter module in your iOS app
 
 While there are multiple ways to embed a Flutter module in an iOS app, Shorebird
 requires that your Flutter module be embedded in your iOS app as an
 .xcframework.
 
-:::note The steps to do this are the same as the
+:::note
+
+The steps to do this are the same as the
 [option B in the official instructions](https://docs.flutter.dev/add-to-app/ios/project-setup#option-b---embed-frameworks-in-xcode),
 so in the event of a conflict between the docs here and the official docs, defer
-to the official docs. :::
+to the official docs.
 
-:::note `ShorebirdFlutter.xcframework` is nearly identically to
-`Flutter.xcframework` from Google, but as part of compliance with Apple's
-signing requirements, we've renamed the framework when applying Shorebird
-(legally Code Town, Inc's) digital signature. :::
+:::
+
+:::note
+
+`ShorebirdFlutter.xcframework` is nearly identically to `Flutter.xcframework`
+from Google, but as part of compliance with Apple's signing requirements, we've
+renamed the framework when applying Shorebird (legally Code Town, Inc's) digital
+signature.
+
+:::
 
 ### Add the path to your .xcframeworks to Framework Search Paths
 
@@ -101,8 +117,12 @@ Content" section. Make sure to select "Embed & Sign" for both frameworks.
 
 ![Xcode embed frameworks](https://github.com/shorebirdtech/shorebird/assets/581764/fe5911bd-046b-47f9-a4d8-d8548e651bd6)
 
-:::note You may also see that `ShorebirdFlutter.xcframework` is signed by Code
-Town Inc. That's us 🙂 :::
+:::note
+
+You may also see that `ShorebirdFlutter.xcframework` is signed by Code Town Inc.
+That's us 🙂
+
+:::
 
 ## Verify that your app runs
 

src/content/docs/Code Push/Guides/Submitting/app-store.mdx

@@ -99,21 +99,28 @@ To upload to the App Store, do one of the following:
        See "man altool" for details about how to authenticate with the App Store Connect API key.
 ```
 
-:::note If you perform your own code signing and do not want Shorebird to
-codesign your app, you can pass the `--no-codesign` flag to the
-`shorebird release ios` command. Because only signed code can be run on iOS
-devices, **releases created this way will not be previewable using the
-`shorebird preview` command.** You can still download and run these releases
-through TestFlight. :::
-
-:::note Shorebird uses the Release configuration to package your app. If you
-need to provide custom settings for archiving your app (e.g., provisioning
-profiles), you can do this by providing an exportOptions.plist file to the
-release command using the `--export-options-plist` flag.
+:::note
+
+If you perform your own code signing and do not want Shorebird to codesign your
+app, you can pass the `--no-codesign` flag to the `shorebird release ios`
+command. Because only signed code can be run on iOS devices, **releases created
+this way will not be previewable using the `shorebird preview` command.** You
+can still download and run these releases through TestFlight.
+
+:::
+
+:::note
+
+Shorebird uses the Release configuration to package your app. If you need to
+provide custom settings for archiving your app (e.g., provisioning profiles),
+you can do this by providing an exportOptions.plist file to the release command
+using the `--export-options-plist` flag.
 
 To view a list of settings that can be controlled by an `exportOptions.plist`,
 run `xcodebuild --help` and look under the
-`Available keys for -exportOptionsPlist` heading. :::
+`Available keys for -exportOptionsPlist` heading.
+
+:::
 
 ## Upload to the App Store
 

src/content/docs/Code Push/Guides/Submitting/play-store.mdx

@@ -260,4 +260,8 @@ git branch -D v1.0.3+6-patch1
 git push origin --delete v1.0.3+6-patch1
 ```
 
-:::note This change is still accessible via the `v1.0.3+6-patch1` tag. :::
+:::note
+
+This change is still accessible via the `v1.0.3+6-patch1` tag.
+
+:::

src/content/docs/Code Push/Guides/development-workflow.mdx

@@ -100,8 +100,9 @@ distributed to customers via the appropriate channels.
 
 ![Release Workflow](https://github.com/user-attachments/assets/7c9cf689-bd07-40c0-ad0b-e08935cb4424)
 
-:::note For more information about configuring signing refer to the following
-links:
+:::note
+
+For more information about configuring signing refer to the following links:
 
 - [Create an Upload Keystore (Android)](https://docs.flutter.dev/deployment/android#create-an-upload-keystore)
 - [Installing an Apple Certificate on MacOS Runners (iOS)](https://docs.github.com/en/actions/use-cases-and-examples/deploying/installing-an-apple-certificate-on-macos-runners-for-xcode-development)