Skip to content

Commit

Permalink
Merge pull request #797 from marionbarker/working-docs
Browse files Browse the repository at this point in the history
Fix typos, change to more neutral language
  • Loading branch information
marionbarker authored Feb 14, 2024
2 parents c0681ac + c281cbd commit a3df6ad
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/build/testflight-xcode.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Some useful features of using TestFlight to install Loop:
* You can update Loop on your kid's phone while they're away at college
* Reinstalling Loop on the fly is quick and easy from your phone, even if you accidentally delete the app, see [Protect that App](build-app.md#protect-that-app), or need to install Loop on a brand new phone

Since apps built with TestFlight expire after 90 days, it is recommended you also setup a build using the [Build with Browser](../gh-actions/gh-overview.md) method even if you don't plan on using it. The GitHub build can be updated in a few minutes from any browser and is an extra layer of protection in these scenarios if you do not have access to your Mac for a rebuild:
Since apps built with TestFlight expire after 90 days, it is suggested you also setup a build using the [Build with Browser](../gh-actions/gh-overview.md) method even if you don't plan on using it. The GitHub build can be updated in a few minutes from any browser and is an extra layer of protection in these scenarios if you do not have access to your Mac for a rebuild:

* Your Xcode built Loop in TestFlight expires
* An urgent update to Loop is released
Expand Down
2 changes: 1 addition & 1 deletion docs/faqs/apple-health-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The relationship between *Loop* and *Apple* HealthKit is very important to under
* If you delete an entry from the `Event History` list, but leave that same entry in Health, *Loop* reads it back from Health
* It will not show up in the Event History, but it will still contribute to IOB
* You must delete a pump event from both `Event History` and Health data; it is best if you do this within one loop cycle
* If that dose showed up in `Event History`` but you could not find it in Health, look again after the next loop cycle
* If that dose showed up in `Event History` but you could not find it in Health, look again after the next loop cycle
* If you delete an entry from Health, but leave that same entry in `Event History`, *Loop* reports it to Health again
* You must delete a pump event from both the `Event History` list and Health data; it is best if you do this within one loop cycle

Expand Down
2 changes: 1 addition & 1 deletion docs/gh-actions/gh-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ If you get an error, please consult:

## Building the Development Version of the App

For experienced and/or advanced users who want to build the development version of the app, there is additional information at the link below. If you have not built using the browser build method before, it is strongly recommended you first build the released version. Once you have a successful build, then follow the steps for the development version. Building the app is independent of installing the app on your phone from *TestFlight*.
For experienced and/or advanced users who want to build the development version of the app, there is additional information at the link below. If you have not built using the browser build method before, it is suggested you first build the released version. Once you have a successful build, then follow the steps for the development version. Building the app is independent of installing the app on your phone from *TestFlight*.

* [Build Development Version](build-dev-browser.md)

Expand Down
5 changes: 3 additions & 2 deletions docs/intro/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

With the release of&nbsp;_<span translate="no">Loop 3</span>_&nbsp;, there are two ways to build the app.

* If you have never built&nbsp;_<span translate="no">Loop</span>_&nbsp;before, we recommend you use the Build with Browser method.
* If you use a Mac and keep the operating system up to date all the time, then you may prefer the Build with *Mac* method.
* If you have never built&nbsp;_<span translate="no">Loop</span>_&nbsp;before:
* If you already own a Mac then you may prefer the Build with Mac method
* For all others, you will probably prefer the Build with Browser method

The Build Steps have been split into two tabs:

Expand Down
6 changes: 3 additions & 3 deletions docs/loop-3/add-cgm.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ You can find the **transmitter ID** in your Dexcom G6 app or on the back of the
![picture of transmitter box with arrow and marking of transmitter id (sn)](img/dexcom-g6-transmitter-box-sn.svg){width="350"}
{align="center"}

It is recommended that you enable [Remote Upload from Loop](#remote-upload-from-loop).
It is suggested that you enable [Remote Upload from Loop](#remote-upload-from-loop).

#### Change Dexcom Sensor

Expand Down Expand Up @@ -119,7 +119,7 @@ This is only available on Loop 3.

You must have the G7 app on the same phone as Loop. When the G7 app switches to the next sensor/transmitter assembly, Loop automatically switches too.

It is recommended that you enable [Remote Upload from Loop](#remote-upload-from-loop).
It is suggested that you enable [Remote Upload from Loop](#remote-upload-from-loop).

![graphic showing Loop searching for G7](img/g7.svg){width="500"}
{align="center"}
Expand Down Expand Up @@ -168,7 +168,7 @@ In addition to the risks of missing data if the internet is not reliable, you mu

There are third party apps that bring Libre data to your Loop phone and there are customization instructions starting at [Libre Support for Loop 3.2.x Code](../version/code-custom-edits.md#libre-support-for-loop-32x-code) that explain how to modify Loop 3 to use one of those apps. Please use these steps to get a version of Loop that does not rely on internet access to work.

It is recommended that you use Open Loop during warmup until the new sensor begins to provide reasonable data. This is especially important with European Libre 2 using direct bluetooth connection.
It is suggested that you use Open Loop during warmup until the new sensor begins to provide reasonable data. This is especially important with European Libre 2 using direct bluetooth connection.

The xDrip4iOS app (which can also be found in the app store under the name Shuggah) may have a problem during warmup of a new sensor (European Libre 2 using direct bluetooth connection). There were two instances of crazy high values being reported and picked up by Loop 3. One Shuggah user and one xDrip4iOS user who connected via Nighscout as a CGM with Loop 3 had serious overdose of insulin because of bad readings with a new sensor. The developers of xDrip4iOS fixed their application - so make sure you have the latest version. Those developers have no control over what is provided by Shuggah.

Expand Down
6 changes: 3 additions & 3 deletions docs/version/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The simulators for the Pump and CGM, for the `dev` branch show a new format when

### Algorithm Experiments

Two algorithm experiments have been added to `dev``. These are &nbsp;<span translate="no">Glucose Based Partial Application</span>&nbsp; and &nbsp;<span translate="no">Integral Retrospective Correction</span>. They can be viewed on the Loop Settings screen just below Therapy Settings and Usage Data Sharing as shown in the graphic below:
Two algorithm experiments have been added to `dev`. These are &nbsp;<span translate="no">Glucose Based Partial Application</span>&nbsp; and &nbsp;<span translate="no">Integral Retrospective Correction</span>. They can be viewed on the Loop Settings screen just below Therapy Settings and Usage Data Sharing as shown in the graphic below:

![algorithm experiments](img/algorithm-experiments.svg){width="650"}
{align="center"}
Expand Down Expand Up @@ -196,7 +196,7 @@ Note that the automatic build feature is opt-out. In other words, unless you tak
* Automatically build a new version once a month, with automatic update included
* Automatically update your fork of LoopWorkspace once a week if updates are available

It is strongly recommended that all users of the released code (main branch), maintain this automatic schedule so they are never without a valid and up-to-date&nbsp;_<span translate="no">Loop</span>_&nbsp;in their *TestFlight* app.
It is suggested that all users of the released code (main branch), maintain this automatic schedule so they are never without a valid and up-to-date&nbsp;_<span translate="no">Loop</span>_&nbsp;in their *TestFlight* app.

For users of the `dev` branch, it is not uncommon to disable the automatic update portion so they can choose when to update their development version, but should probably keep the monthly build portion of the process.

Expand Down Expand Up @@ -235,7 +235,7 @@ The code that feeds Loop data to remote services like Tidepool and Nightscout ha

There is a lot of discussion about *branches* with *Loop* but the concept is simple. Basically, they are all slightly different versions of *Loop*...kind of like different edits of the same book.

To really understand what branches are, we should probably explain a little more about the software and how development works. You can watch a 30-minute long, classic Katie DiSimone [video explanation about branches](https://www.youtube.com/watch?v=cWqvYs4Azt0&t=4s){: target="_blank" } created when *Loop* Version 2.0 was newly released. Keep in mind while watching the video that `master` was the old name for the `main` branch. The information in this video is still generally useful with the last half focused on automatic-bolus - the automatic-bolus dosing strategy has now been incorporated into <span>*Loop* `main` branch</span>. *Loop* has moved on to using only one stable branch (`main`), with `dev` recommended for developers/testers.
To really understand what branches are, we should probably explain a little more about the software and how development works. You can watch a 30-minute long, classic Katie DiSimone [video explanation about branches](https://www.youtube.com/watch?v=cWqvYs4Azt0&t=4s){: target="_blank" } created when *Loop* Version 2.0 was newly released. Keep in mind while watching the video that `master` was the old name for the `main` branch. The information in this video is still generally useful with the last half focused on automatic-bolus - the automatic-bolus dosing strategy has now been incorporated into <span>*Loop* `main` branch</span>. *Loop* has moved on to using only one stable branch (`main`), with `dev` suggested for developers/testers.

### `Loop` GitHub Information

Expand Down

0 comments on commit a3df6ad

Please sign in to comment.