Skip to content

Commit

Permalink
Merge pull request #860 from marionbarker/working-docs
Browse files Browse the repository at this point in the history
Updates for version 3.4.x release
  • Loading branch information
marionbarker authored Aug 30, 2024
2 parents 7def6af + 9bd8d9c commit 6245b76
Show file tree
Hide file tree
Showing 13 changed files with 17,223 additions and 137 deletions.
239 changes: 174 additions & 65 deletions docs/browser/edit-browser.md

Large diffs are not rendered by default.

Binary file added docs/browser/img/browser-open-to-patch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,586 changes: 2,586 additions & 0 deletions docs/browser/img/modify-build-loop-yml.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9,252 changes: 9,252 additions & 0 deletions docs/browser/img/navigate-submodule-omnible.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,111 changes: 5,111 additions & 0 deletions docs/browser/img/prepare-workspace-patch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 31 additions & 3 deletions docs/browser/phone-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,43 @@ Once the app is available in *TestFlight*, you can adjust whether it is automati

Go back to the *TestFlight* app on your phone and tap on your app name in the list to see an expanded screen similar to the graphic below. The row to enable or disable automatic updates is highlighted in the graphic, which shows the feature disabled. This is recommended for all users.

* If you leave automatic update enabled (default), then whenever a new build is created and uploaded to *TestFlight* , it will be installed immediately.
* WARNING: If you switch between Building with Browser and *Mac*, you must disable automatic update or Xcode will not be able to install to your phone.
* If you leave automatic update enabled (default), then whenever a new build is created and uploaded to *TestFlight* , it will be installed immediately (see [Unexpected *TestFlight* Expiration](#unexpected-testflight-expiration))
* WARNING: If you switch between Building with Browser and *Mac*, you must disable automatic update or Xcode will not be able to install to your phone

![enable or disable automatic update for Loop](img/testflight-auto-update.png){width="300"}
{align="center"}

When you are ready to install, just open the *TestFlight* app and click Install to get the most recent build and then click Open when it completes the installation. All your settings and connections to CGM and Pump are maintained.

If you tap on the bottom row that says `Previous Builds`, highlighted by the dashed-green rectangle, you can view and choose an older build (as long as it has not expired).
### Previous Builds

If you tap on the bottom row that says `Previous Builds`, highlighted by the dashed-green rectangle, you can view and choose an older (or lower version number) build (as long as it has not expired).

* In some cases, you need to do this to see the newest build
* For example, it you build version 3.5.0 (`dev` branch) accidentally and then switched to 3.4.x (`main` branch), *TestFlight* shows you the 3.5.0 version on the screen and you need to go to previous builds to find your newer 3.4.x build

### Unexpected *TestFlight* Beta Expiration

!!! important "*Apple TestFlight* Bug"
It doesn't happen to everyone but it has happened a few times over the years and only for people who have Automatic Update enabled for their *TestFlight* app.

Symptom:

* App has plenty of time before expiration
* A new build becomes available, for example from the automatic monthly rebuild
* User is told *Loop* Beta is not available

Solution:

* Open *TestFlight* and turn off automatic installation for your app
* Install the previous version of the app on the phone manually (with monthly build, it should still be ok)
* Manually start a new build (if there were updates you want to get)
* Manually install the new update

More information:

* [Link 1: Apple forum](https://forums.developer.apple.com/forums/thread/720033){: target="_blank" }
* [Link 2: Stackoverflow thread](https://stackoverflow.com/questions/74588716/testflight-beta-has-expired){: target="_blank" }

## *TestFlight* for a Child

Expand Down
1 change: 0 additions & 1 deletion docs/build/build-dev-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ There is a script to assist in building the `dev branch`. It gives you the optio
/bin/bash -c "$(curl -fsSL \
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoopDev.sh)"
```
Both the `dev branch` and the lightly tested branch of `dev` have Libre support.

### BuildLoopDev Other Branches

Expand Down
2 changes: 1 addition & 1 deletion docs/loop-3/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Two algorithm experiments are now available in the *Loop* app (version 3.4.0 or
* The "switcher" patch is no longer compatible
* The GBPA feature is intended to replace the functionality of that older customization and is controlled completely inside the *Loop* app

_<span translate="no">Glucose Based Partial Application</span>_ is only used when _Automatic Bolus_ (AB) is selected for _Temp Basal Only_ _Dosing Strategy_
_<span translate="no">Glucose Based Partial Application</span>_ is only used when _Automatic Bolus_ (AB) is selected for _Dosing Strategy_

* This modification **does not affect the recommended dose**, only how quickly the recommended dose is automatically delivered

Expand Down
20 changes: 12 additions & 8 deletions docs/version/build-time-flag.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
## Overview

Build-time features are not available with Loop 2.2.x.

With Loop 3, some features are enabled or disabled by default but can be modified by adding a "flag" in the LoopConfigOverride.xcconfig file.

If you use Build with Browser, these build-time features can be added to your copy of the LoopConfigOverride.xcconfig file. Use the pencil icon in that file on your copy of LoopWorkspace and then commit the change.
## Modify the `Build Time Flags`

If you use the Build with *Mac* Method, this is the same file used to automatically sign all your targets. You can edit the version in your LoopWorkspace folder (it shows up as the top item in the Xcode folder view) - or - if you use the build script, you can edit the copy found in ~/Downloads/BuildLoop after the first time you use the script. For that second case, the "flags" you add in ~/Downloads/BuildLoop/LoopConfigOverride.xcconfig are applied to all downloads created with the script.
The `Build Time Flags` are available for both build methods:

These flags are always upper case with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line.
* **Build with Browser**
* Edit the LoopConfigOverride.xcconfig file in your fork
* Use the pencil icon in that file to make the modification shown below and commit the change to your fork
* Do not try to open a pull request to LoopKit/LoopWorkspace - only modify your-github-username/LoopWorkspace version
* **Build with *Mac* Method**
* You edit the file used to automatically sign all your targets
* You can edit the version in your LoopWorkspace folder (it shows up as the top item in the Xcode folder view) - or - if you use the build script, you can edit the copy found in ~/Downloads/BuildLoop after the first time you use the script.
* If you edit `~/Downloads/BuildLoop/LoopConfigOverride.xcconfig`, the "flags" you add are applied to this download and all subsequent downloads created with the script.

!!! question "New Instructions"
The instructions are more robust than earlier instructions that had you editing a line instead of adding new ones.
These flags are always upper case with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line.

Copy the text below, add it to the end of your LoopConfigOverride.xcconfig file and then insert the desired flags in place of `MY_EXAMPLE_FLAG`. If you want more than one flag, separate them by a space.

Expand Down Expand Up @@ -40,7 +44,7 @@ _Code After Modification_
SWIFT_ACTIVE_COMPILATION_CONDITIONS = $(SWIFT_ACTIVE_COMPILATION_CONDITIONS) SIRI_DISABLED
```

List of some flags and what they do:
## Table of Build Time Flags

|FLAG|PURPOSE|
|---------|---------|
Expand Down
Loading

0 comments on commit 6245b76

Please sign in to comment.