Skip to content

Commit

Permalink
docs: Update FAQ that we have no current plans to support on-prem (#272)
Browse files Browse the repository at this point in the history
* docs: Update FAQ that we have no current plans to support on-prem

Also updated status page now that iOS works well for most users.

* chore: run npm format

---------

Co-authored-by: Felix Angelov <[email protected]>
  • Loading branch information
eseidel and felangel authored Jul 24, 2024
1 parent 9aa3477 commit 2fadaa8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 42 deletions.
6 changes: 3 additions & 3 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ or priorities via GitHub issues or [Discord](https://discord.gg/shorebird).

### Can I self-host Shorebird?

Not currently. We intend to offer [cloud-prem and on-prem
hosting](https://github.com/shorebirdtech/shorebird/issues/485) as an option on
enterprise plans. Please contact us if such is required for your adoption.
No. Shorebird has no current plans to offer on-prem, self-host or cloud-prem
offerings. We would be happy to discuss with you any and all ways in which we
can improve our centrally hosted solution to best match your needs.

### Can I use Shorebird with my team?

Expand Down
48 changes: 9 additions & 39 deletions src/content/docs/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,16 @@ title: Status
description: Status of the Shorebird project.
---

Shorebird is available on Android and iOS, with ~1000 apps using Shorebird on
the App Store and Play Store.
There are no known major issues with Shorebird on iOS or Android.

## Link Percentage (iOS)
Issues affecting some customers:

As part of [complying with the the App Store
guidelines](/faq#does-shorebird-comply-with-app-store-guidelines), Shorebird uses
an interpreter on iOS to run any changed Dart code in your patch. This
interpreter runs Dart about 100x slower than running on the CPU. To make patches
run fast, Shorebird has modified the Dart compiler and runtime to make it
possible to _only_ run changed code on the interpreter and run any unchanged
code on the CPU. This determination is done at a per-function level.
- `--obfuscate` does not work with iOS builds on Shorebird.
https://github.com/shorebirdtech/shorebird/issues/1619
- Would like to share groups of apps with my company: https://github.com/shorebirdtech/shorebird/issues/739 (For now, can help you do this via our support email see https://docs.shorebird.dev/teams/).

The program that decides which code runs on the CPU vs the interpreter is called
the "linker" and we call this percentage the "link percentage".
A full list of reported issues and feature requests is available on GitHub:
https://github.com/shorebirdtech/shorebird/

Most of the time this system works very well, and Shorebird is able to run 90%+
of your Dart code on the CPU. However there are still a few types of changes
which can confuse the "linker" into running more code on the interpreter than
necessary.

Known linker issues include:

- [iOS possible low link percentage](https://github.com/shorebirdtech/shorebird/issues/1892)

If your app has reported an unexpectedly low link percentage, please let us
know, we'd love to help. You can report an issue here:
https://github.com/shorebirdtech/shorebird/issues
Or reach us via Discord: https://discord.gg/shorebird.

:::note
Link percentage is not itself a great measure of performance. We've seen apps
link only 30% and run smoothly, and other apps link 99.5% and struggle to run
at 30fps. What matters is that the hot code paths in your app end up on the
CPU. Most of the time, all the hot code paths in your app are the ones deep
inside Flutter's framework (which very few apps ever change), and those end up
on the CPU. However if your app does a lot of intensive computation in Dart,
you may notice a slowdown in your app if you change those functions in a patch.

Regardless, if you ever see slowdowns when patching your app, please
let us know. There are many ways we can continue to improve Shorebird's
update system to run patches without any performance impact.
:::
You can see our project boards with scheduled work on GitHub:
https://github.com/orgs/shorebirdtech/projects/

0 comments on commit 2fadaa8

Please sign in to comment.