Skip to content

Commit

Permalink
Merge pull request LoopKit#829 from ebouchut/fix/issue_826-anchors_in…
Browse files Browse the repository at this point in the history
…_links

✏️ Fix broken anchors in links
  • Loading branch information
ebouchut authored May 12, 2024
2 parents c5f6d08 + c2ee913 commit b6eaf90
Show file tree
Hide file tree
Showing 23 changed files with 39 additions and 41 deletions.
2 changes: 1 addition & 1 deletion docs/build/build-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ For more information, please see [Operate: Apple Watch](../operation/features/wa

### Build Again with this Download

Follow the [Find My Downloaded Loop Code](custom-mac.md#find-my-downloaded-loop-code) instructions if you later wish to build with this same dowload. Plug in an unlocked phone and start at the [Start Build](#start-build) section of this page. You may need to select the phone you just plugged in. Everything else should be ready for you the start the build process.
Follow the [Find My Downloaded Loop Code](edit-mac.md#find-my-downloaded-loop-code) instructions if you later wish to build with this same dowload. Plug in an unlocked phone and start at the [Start Build](#start-build) section of this page. You may need to select the phone you just plugged in. Everything else should be ready for you the start the build process.

!!! warning "Don't use a really old download"
Do not use a really old download.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/build-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Before you start trying to resolve your red errors, start with the most obvious

1. **Did you get a fresh download of Loop code?** If you tried to build with an old download that you used a long time ago, that old version may not be compatible with the new iOS and Xcode versions. Check also, that you are actually using the new download in Xcode. When you use the Build Select Script, it automatically opens Xcode using the new download.

If you want to build using a recent download, this section tells you how to [Find My Downloaded Loop Code](custom-mac.md#find-my-downloaded-loop-code).
If you want to build using a recent download, this section tells you how to [Find My Downloaded Loop Code](edit-mac.md#find-my-downloaded-loop-code).

1. **Are you are using a free developer account?** Make sure you finished the removal of Siri and Push Notification capabilities described in the [Free Account](build-free-loop.md#free-account) link.

Expand Down
2 changes: 1 addition & 1 deletion docs/build/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Each requirement in the list is linked to the LoopDocs pages with more informati

### Build with *Mac* Additional Requirements

1. [Compatible Computer](../build/computer.md#macos)
1. [Compatible Computer](../build/computer.md#check-your-macos-version)
1. [Xcode](../build/xcode-version.md) (a free Apple application)

If using a *Mac* to build to a [Simulator](../version/simulator.md) to try things out, the only requirements are a computer and Xcode.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Minimum means you need to have at least that version - newer versions build just

Click on this link [Check your Xcode Version](xcode-settings.md#xcode-version) to find your Xcode version number.

If you need to update your Xcode, follow the instructions at this link [Install Xcode](xcode-version.md#install-xcode) and continue through [Xcode Settings](xcode-settings.md).
If you need to update your Xcode, follow the instructions at this link [Install Xcode](xcode-version.md#which-version-of-xcode-do-i-need) and continue through [Xcode Settings](xcode-settings.md).

Advanced users: If you are finding installation of Xcode from the App Store incredibly slow, try the alternate method of [Direct Download of Xcode](#direct-download-of-xcode).

Expand Down
2 changes: 1 addition & 1 deletion docs/faqs/loop-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ You no longer need to own an *Apple* computer - see [Build with Browser](../gh-a

If you chose [Build with *Mac*](../build/overview.md), then you still don't **have** to own an *Apple* computer, but you do need to at least borrow one - or you can build using a virtual *Mac* if you have a PC with Intel chips (see next section).

If you are borrowing an *Apple* computer, look at the required minimum settings associated with your iPhone [Compatible Computer](../build/computer.md#macos) and [Xcode Version](../build/xcode-version.md#how-do-all-the-minimum-versions-relate-to-each-other). It would be really good to have the longer-term ability to borrow that computer again for [updating Loop](../build/updating.md#when-to-update) later when needed.
If you are borrowing an *Apple* computer, look at the required minimum settings associated with your iPhone [Compatible Computer](../build/computer.md#check-your-macos-version)) and [Xcode Version](../build/xcode-version.md#how-do-all-the-minimum-versions-relate-to-each-other). It would be really good to have the longer-term ability to borrow that computer again for [updating Loop](../build/updating.md#when-to-update-loop) later when needed.

## Can I use a PC or Windows computer to build?

Expand Down
2 changes: 1 addition & 1 deletion docs/faqs/new-phone.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ On old phone (if available):
It is now time to transfer the CGM to the new phone.

* [Dexcom CGM](#dexcom-cgm)
* [<span translate="no">Libre</span>&nbsp;CGM](#librecgm)
* [<span translate="no">Libre</span>&nbsp;CGM](#libre-cgm)

#### Dexcom CGM

Expand Down
2 changes: 1 addition & 1 deletion docs/faqs/rileylink-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Purchase information for these devices is found in [RileyLink Compatible Devices

You can add or change the RileyLink compatible device in use without affecting the pump that is connected to the Loop app. You can even have [more than one connected](#using-more-than-one-device), although only one will be used at a time.

If you are connecting to a new Medtronic pump or switching between Medtronic and Omnipod, please follow the [Modify Pump](../loop-3/add-pump.md#modify-pump) instructions under Set up App.
If you are connecting to a new Medtronic pump or switching between Medtronic and Omnipod, please follow the [Change Pump Type](../loop-3/add-pump.md#change-pump-type) instructions under Set up App.


Change Connected Devices:
Expand Down
2 changes: 1 addition & 1 deletion docs/gh-actions/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ If you choose not to have automatic building enabled, be sure the `GH_PAT` has `
What if I decide I don't want the automatic building feature?

* If you are using the released version of Loop, please leave automatic building running
* Please read [TestFlight Automatic Updates](gh-deploy.md#testflight-automatic-updates) on how to configure TestFlight so you choose when the updated app gets installed on your phone
* Please read [TestFlight Automatic Updates](gh-deploy.md#automatic-update-build-install) on how to configure TestFlight so you choose when the updated app gets installed on your phone
* Otherwise, you may see the dreaded "Loop Beta has expired" message, have a Loop that won't open and not have a version ready to go in TestFlight that you can install within a few seconds

* If you are taking a break from Loop and want to stop monthly Build emails, consider disabling actions for the `Build Loop` action for your app.
Expand Down
4 changes: 2 additions & 2 deletions docs/gh-actions/edit-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Look also at the Stable line for the desired customization:
## Outline of What Happens in the Module

!!! warning "Review Only"
Review this section so you know what to expect. The actual steps will come later, starting with [Create your <code>Fork</code> for Selected Module](#create-your-fork-for-selected-module) or [Edit Module in Browser](#edit-module-in-browser).
Review this section so you know what to expect. The actual steps will come later, starting with [Create your <code>Fork</code> for Selected Module](#create-your-fork-for-selected-module) or [Edit Module in Browser](#personalized-customization-for-this-module).

In the next sections, the exact process for making changes will be documented. But the steps may feel confusing. There are no links here because you are supposed to review the steps before taking action in the next section.

Expand Down Expand Up @@ -295,7 +295,7 @@ Repeat this process until you've done all your customizations for this Module an
Once you prepare the commands, then you will edit the build_loop.yml file of your <code>fork</code> of&nbsp;<span translate="no">LoopWorkspace</span>.

!!! warning "Ensure your <code>fork</code> is from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>"
If your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;did not come from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>, then delete your existing <code>fork</code> and make a new one. See [Already Have&nbsp;<span translate="no">LoopWorkspace</span>?](gh-first-time.md#already-haveloopworkspace).
If your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;did not come from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>, then delete your existing <code>fork</code> and make a new one. See [Already Have&nbsp;<span translate="no">LoopWorkspace</span>?](gh-first-time.md#already-have-loopworkspace).

* Do not use any other location to create your <code>fork</code>
* You may have used a different location for Loop 3.2.2
Expand Down
2 changes: 1 addition & 1 deletion docs/gh-actions/gh-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Recommended settings:
* Allow automatic build and upload to *TestFlight*
* [Disable automatic installation](#disable-automatic-install-from-testflight) on phone from *TestFlight*

If you are running the development code, you may prefer to turn off the automatic update, but keep the automatic build. To read more about modifying automatic update and build options, please read [Modify Automatic Building](gh-update.md#modify-automatic-building).
If you are running the development code, you may prefer to turn off the automatic update, but keep the automatic build. To read more about modifying automatic update and build options, please read [Modify Automatic Building](automatic.md#modify-automatic-building).

## Disable Automatic Install from *TestFlight*

Expand Down
8 changes: 4 additions & 4 deletions docs/gh-actions/gh-first-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* [`Action: 3. Create Certificates`](#create-certificates)
* [`Action: 4. Build Loop`](#build-the-loop-app)
* _<span translate="no">Apple</span>_: [Set up `Internal TestFlight Group`](#set-up-users-and-access-testflight)
* Phone: [Install the *Loop* app using the *TestFlight* app](../gh-actions/gh-deploy.md#deploy-using-testflight)
* Phone: [Install the *Loop* app using the *TestFlight* app](#install-on-phone)

???+ question "FAQs (click to open/close)"
- **Do I need a Mac computer?** No. This can be done on any browser, although it will be easier using a computer or tablet than just using a phone.
Expand Down Expand Up @@ -207,7 +207,7 @@ If this summary of terms is confusing, finish reviewing the whole page and then
* Six <code>Secrets</code> must be added to your fork of LoopWorkspace
* These <code>Secrets</code> work for any branch in your fork (`main` or `dev`, for example)
* These <code>Secrets</code> can be added to [Other Apps](gh-other-apps.md) configured with the same <code>*GitHub* Browser Build</code> method
* For those who feel confident using *GitHub*, there are optional instructions to configure a free organizational account (for your personal use) that allows you to enter the <code>Secrets</code> only once, see [Use a *GitHub* Organization Account](gh-other-apps.md#use-agithub-organization-account), and have them available for every repository in that organization account
* For those who feel confident using *GitHub*, there are optional instructions to configure a free organizational account (for your personal use) that allows you to enter the <code>Secrets</code> only once, see [Use a *GitHub* Organization Account](gh-other-apps.md#use-a-github-organization-account), and have them available for every repository in that organization account
* API `Key`:`Application Programming Interface Key`
* You obtain and save this key from the *Apple Developer* website
* Doing this provides 3 of your <code>Secrets</code>
Expand Down Expand Up @@ -623,12 +623,12 @@ You will not directly interact with your `Match-Secrets` repository.
[<span class="loop-bigger">:material-skip-forward:</span>](#configure-secrets) To skip the detailed instructions, click on [Configure <code>Secrets</code>](#configure-secrets)
!!! warning "Existing Fork"
If you already have a fork of <code>LoopWorkspace</code>, click on [Already Have LoopWorkspace](#already-haveloopworkspace) to decide what to do. That section provides links to return you to these instructions.
If you already have a fork of <code>LoopWorkspace</code>, click on [Already Have LoopWorkspace](#already-have-loopworkspace) to decide what to do. That section provides links to return you to these instructions.
1. Open this link [https://github.com/LoopKit/LoopWorkspace](https://github.com/LoopKit/LoopWorkspace){: target="_blank" } to open the <code>LoopWorkspace</code> repository owned by `LoopKit`.
1. Review the highlighted locations of the graphic below (yours won't look quite like this yet, but the `Fork` button is in the same place)
1. At the upper right side of the screen, click on the word `Fork`
* If you already have a fork, you cannot proceed, see [Already Have LoopWorkspace](#already-haveloopworkspace)
* If you already have a fork, you cannot proceed, see [Already Have a LoopWorkspace](#already-have-loopworkspace)
1. Now your screen should look like the graphic below
* Your username will be automatically filled in as the owner (`Owner`)
* <code>LoopWorkspace</code> is the repository name (`Repository Name`)
Expand Down
2 changes: 1 addition & 1 deletion docs/intro/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Detailed instructions are included in the link above.

If you plan to build using the Build with *Mac* instructions, you also need:

1. [Compatible Computer](../build/computer.md#macos)
1. [Compatible Computer](../build/computer.md#check-your-macos-version)
1. [Xcode](../build/xcode-version.md) (a free Apple application)


Expand Down
10 changes: 5 additions & 5 deletions docs/loop-3/add-cgm.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,20 +157,20 @@ The Medtronic Enlite CGM is only available if you have connected it to your comp

If the user is already uploading CGM data to their Nightscout URL, they can select that as a source for CGM data for Loop. The user must acknowledge they understand the risks of using a remote source that requires internet, as shown in the graphic below.

In addition to the risks of missing data if the internet is not reliable, you must also make sure the CGM data sent to Nightscout is reliable.
In addition to the risks of missing data, if the internet is not reliable, you must also make sure the CGM data sent to Nightscout is reliable.

!!! important "DANGER - Make sure Nightscout CGM Data is Reliable"
Just because you can use Nightscout as a CGM source does not mean you should.

If you decide to use Nightscout as a CGM source, make sure the data stored in Nightscout is reliable. If the app you choose uploads bad results to Nightscout, you don't want Loop to use that bad data.

_Sensors that can be added to Nightscout via other apps include Dexcom, some Libre and some Medtronic sensors. Please refer to [Nightscout Docs: Configure your Uploader](https://nightscout.github.io/uploader/setup/){: target="_blank" }._
_Sensors that can be added to Nightscout via other apps include Dexcom, some Libre, and some Medtronic sensors. Please refer to [Nightscout Docs: Configure your Uploader](https://nightscout.github.io/uploader/setup/){: target="_blank" }._

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.
There are third-party apps that bring Libre data to your Loop phone. Cuustomization instructions are provided at the `Loop and Learn` website: [Libre Support for Loop 3.2.x](https://www.loopandlearn.org/custom-code/#add-cgm-browser){: target="_blank" } that explain how to modify Loop 3 to use one of those apps for Browser Build. The Mac instructions are found on the same page. Please use these steps to get a version of Loop that does not rely on internet access to work.

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.
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 a 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.
The xDrip4iOS app (which can also be found in the app store under the name Shuggah) may have a problem during the warmup of a new sensor (European Libre 2 using a 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 a 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.


![Nightscout Remote CGM acknowledgement screen](img/nightscout-cgm-acknowledge.svg){width="350"}
Expand Down
6 changes: 3 additions & 3 deletions docs/loop-3/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
This page discusses updated versions of Loop features as well as new capabilities provided with Loop 3.

!!! info "Loop 3 Displays"
One thing you may notice on some screens is the primary button, with associated information message, is always visible at the bottom of even small screens. You may need to scroll to see intermediate rows.
One thing you may notice on some screens is the primary button, with an associated information message, is always visible at the bottom of even small screens. You may need to scroll to see intermediate rows.

For example, if the default action on a bolus screen is to deliver the recommended bolus, that button is visible and active. The button remains fixed as other portions of the screen are scrolled up and down. When you make changes to selections, then the information displayed and the button label updates to reflect the action taken if you tap on the button.

Expand Down Expand Up @@ -54,7 +54,7 @@ With Loop 3, the "old" method still works, but there is a new method for enterin
* Tap on the `Bolus` row (blue dash-dot lines) to bring up a keyboard
* The `Glucose` prediction chart updates automatically based on the value entered in the Bolus row
* Tip, add 0.001 to the actual dose to make it easier to see if reviewing in Apple Health
* Once the user selects `Done` on the keyboard display, the entered value is displayed on the `Bolus` row and the `Log Dose` button changes from gray to blue
* Once the user selects `Done` on the keyboard display, the entered value is displayed on the `Bolus` row, and the `Log Dose` button changes from gray to blue
* Tap on `Log Dose` to record or `Cancel` to quit

![entering non-pump insulin into Loop](img/non-pump-insulin.svg){width="500"}
Expand Down Expand Up @@ -97,7 +97,7 @@ In the graphic below, the user enters carbs and taps continue to display the Mea
![meal bolus when bolus is recommended on left and not recommended on right](img/loop-3-meal-bolus-rec.svg){width="900"}
{align="center"}

If a CGM entry arrives while in this screen, a **Bolus Recommendation Updated** [modal message](onboarding.md#what-does-modal-mean) will be displayed and must be acknowledged.
If a CGM entry arrives while on this screen, a **Bolus Recommendation Updated** modal message will be displayed and must be acknowledged.

#### Modify Bolus

Expand Down
Loading

0 comments on commit b6eaf90

Please sign in to comment.