Skip to content

Commit

Permalink
Merge pull request #780 from ebouchut/doc/open_external_links_in_new_…
Browse files Browse the repository at this point in the history
…window

🚸  UX Improvement: Open external links in a new window
  • Loading branch information
ebouchut authored Jan 26, 2024
2 parents 44f1a46 + 1841b94 commit 902483b
Show file tree
Hide file tree
Showing 79 changed files with 457 additions and 436 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,16 @@ Click here for [When Should You Update?](../faqs/update-faqs.md#when-should-you-
```
❗️Make **external links open in a new window** by appending the `{: target="_blank" }` suffix to the markdown link, like this
```markdown
[LoopTips](https://loopkit.github.io/looptips){: target="_blank" }
```
ℹ️ Note:
- There is **no space** in between the link and `{: target="_blank" }`.
- An *external link* means a link to another website (i.e. not LoopDocs).
ℹ️ **Notice about mkdocs**
> Using absolute paths with links is not officially supported.
Expand Down
10 changes: 5 additions & 5 deletions docs/build/apple-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
- up to 2 days to wait for confirmation email that enrollment has been activated

!!! abstract "Summary"

There are two options: Paid ($99/year) or Free (re-build weekly, Xcode only)

- Paid Developer Account: Go to the [Apple Developer website](https://developer.apple.com/programs/enroll/) to enroll in an individual account.
- Paid Developer Account: Go to the [Apple Developer website](https://developer.apple.com/programs/enroll/){: target="_blank" } to enroll in an individual account.
- Free: No action required at this time.
* Free requires the [Build with *Mac*](overview.md) method

Expand All @@ -22,7 +22,7 @@
The Apple ID is DIFFERENT than the Apple Developer ID.

!!! warning "Apple ID"
Parents should set up a **different** Apple ID for each of their looper children and looper children should **not** use the parent Apple ID. Use Apple's Instructions for [Create an Apple ID for your child](https://support.apple.com/en-us/HT201084).
Parents should set up a **different** Apple ID for each of their looper children and looper children should **not** use the parent Apple ID. Use Apple's Instructions for [Create an Apple ID for your child](https://support.apple.com/en-us/HT201084){: target="_blank" }.

The Apple Health record is a convenient record of blood glucose, insulin and carbohydrates and should be associated with only one individual.

Expand Down Expand Up @@ -75,7 +75,7 @@ Once PaidLoop is working, delete the FreeLoop instance from your phone to avoid

## Enrolling

To enroll in an individual paid Paid account, go to the Apple's Developer Program website [Apple Developer website](https://developer.apple.com/programs/enroll/).
To enroll in an individual paid Paid account, go to the Apple's Developer Program website [Apple Developer website](https://developer.apple.com/programs/enroll/){: target="_blank" }.

Be sure to use the credit card already associated with the email you are using for the developer account. If you switch credit cards, it can cause delays.

Expand Down
10 changes: 5 additions & 5 deletions docs/build/build-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## Build Video

The Loop and Learn team prepared this [YouTube video](https://youtu.be/gddhljzsNkM) showing how to build Loop 2.2.x including the steps required to update if you previously built. The steps are different now. The video may be worth watching, but once you've reviewed it, work through the new build process described on this page.
The Loop and Learn team prepared this [YouTube video](https://youtu.be/gddhljzsNkM){: target="_blank" } showing how to build Loop 2.2.x including the steps required to update if you previously built. The steps are different now. The video may be worth watching, but once you've reviewed it, work through the new build process described on this page.

If you do watch this video, please note that you no longer are required to delete provisioning profiles as a separate step and the overall building process is streamlined.

Expand All @@ -39,7 +39,7 @@ You will see a message similar to the next graphic.
![phone message if trying to run xcode app without developer mode enabled](img/phone-developer-mode-required.jpeg){width="300"}
{align="center"}

If you are running iOS 16 or 17 with watchOS 9 or newer, you must enable <code>Developer Mode</code> to run or build Loop directly from Xcode. (This is true for any app created by Xcode directly on your device.) If you want to know more, click on this [Apple Link about <code>Developer Mode</code>](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device).
If you are running iOS 16 or 17 with watchOS 9 or newer, you must enable <code>Developer Mode</code> to run or build Loop directly from Xcode. (This is true for any app created by Xcode directly on your device.) If you want to know more, click on this [Apple Link about <code>Developer Mode</code>](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device){: target="_blank" }.

### Prepare your Phone and Watch

Expand Down Expand Up @@ -105,7 +105,7 @@ These steps have been reported on Facebook and have not been tested in a control
* Click on the watch and if it connects - you are done
5. Otherwise manually add the UDID to your Developer Account
6. Copy UDID (right-click or control-click and choose Copy Identifier)
7. Go to the [Apple developer website, devices page](https://developer.apple.com/account/resources/devices/list) and manually add the watch (using the UDID)
7. Go to the [Apple developer website, devices page](https://developer.apple.com/account/resources/devices/list){: target="_blank" } and manually add the watch (using the UDID)
8. With phone plugged into computer and watch on wrist, follow these steps on the build errors page: [Apple Watch Loop App not running on Watch](build-errors.md#apple-watch-loop-app-not-running-on-watch) to build the watch app directly.

At this point, be sure to reboot the watch.
Expand All @@ -132,7 +132,7 @@ These instructions show each step needed to download Loop using the Build Select
!!! note "New Menu for Build Select Script"
The Build Select Script has been updated with more menu options. It can do more than just assist in building the Loop app.

Please review [Loop and Learn: Build Select Script](https://www.loopandlearn.org/build-select/) for more information.
Please review [Loop and Learn: Build Select Script](https://www.loopandlearn.org/build-select/){: target="_blank" } for more information.

You may notice some graphics on this page shows red font to emphasize some items. The script now only shows red font for an error. Bold font is used for emphasis. Not all graphics were updated.

Expand Down Expand Up @@ -453,7 +453,7 @@ If you plan to build again on a backup phone, or want to try a customization, ea
But wait - there's more.

* Caregivers who help manage a loved-ones diabetes often use other open-source apps that can be built the same way
* When you are done building and installing the *Loop* app, there are instructions on the *Loop and Learn* website to [Download and Build Related Apps](https://www.loopandlearn.org/build-select/#build-other-apps)
* When you are done building and installing the *Loop* app, there are instructions on the *Loop and Learn* website to [Download and Build Related Apps](https://www.loopandlearn.org/build-select/#build-other-apps){: target="_blank" }

## Protect that App

Expand Down
4 changes: 2 additions & 2 deletions docs/build/build-dev-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ You can use the BuildLoopDev script to build a specific development branch, othe

While Loop-dev is under active development, you should monitor zulipchat and update frequently.

Checking for updates every week is a good idea. Also - subscribe to all the streams on [Loop Zulipchat](https://loop.zulipchat.com) to make sure you don't miss critical information.
Checking for updates every week is a good idea. Also - subscribe to all the streams on [Loop Zulipchat](https://loop.zulipchat.com){: target="_blank" } to make sure you don't miss critical information.

You may choose to download fresh each time you update.

You may prefer to use commands to fetch and pull the latest code without making a new clone.

* Some users like to use [GitKraken](https://support.gitkraken.com/) to assist them (link takes you to a tutorial video).
* Some users like to use [GitKraken](https://support.gitkraken.com/){: target="_blank" } to assist them (link takes you to a tutorial video).
* Some are comfortable with the command line git commands described on [here](../version/loopworkspace.md#updating-loop-using-loopworkspace).

## Loop-dev Version
Expand Down
6 changes: 3 additions & 3 deletions docs/build/build-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Before you start trying to resolve your red errors, start with the most obvious

1. **Did you check that you have the minumum Xcode version for your iOS?** This is critical. If you are updating your Loop app, please review the iOS driven requirements for minimum version of [macOS and Xcode](xcode-version.md#how-do-all-the-minimum-versions-relate-to-each-other).

1. **Did you check your Apple developer account for new license agreement?** Periodically, Apple will release a new developer license agreement that you need to sign before you can build new apps. You will get a build failure if there is a pending license agreement to sign. [Login to your Apple developer account](https://developer.apple.com/account) to check if there's a new license agreement.
1. **Did you check your Apple developer account for new license agreement?** Periodically, Apple will release a new developer license agreement that you need to sign before you can build new apps. You will get a build failure if there is a pending license agreement to sign. [Login to your Apple developer account](https://developer.apple.com/account){: target="_blank" } to check if there's a new license agreement.

1. **Do you have a new computer, never used to build Loop?** Did you [Add Apple ID](xcode-settings.md#add-apple-id) to Xcode?

Expand Down Expand Up @@ -419,7 +419,7 @@ Or maybe you are trying to build using an old download; some older versions did
**Error message:** `The Apple Developer Program License Agreement has been updated, In order to access certain membership resources, you must accept the latest license agreement`.
Or you may see `Unable to process request - PLA Update available. You currently don't have access to this membership resource. To resolve this issue, agree to the latest Program License Agreement in your developer account.`

**Solution:** You'll need to log onto your Apple Developer account at [developer.apple.com](https://developer.apple.com/account/) and accept the latest license agreement.
**Solution:** You'll need to log onto your Apple Developer account at [developer.apple.com](https://developer.apple.com/account/){: target="_blank" } and accept the latest license agreement.

![img/license.png](img/license.png){width="750"}
{align="center"}
Expand Down Expand Up @@ -491,7 +491,7 @@ If your problem persists after that, then you might need to do total reset of yo
![img/pending_certification_request.jpg](img/pending_certification_request.jpg){width="750"}
{align="center"}

**Solution:** This error message has recently started to appear for some new Loop builders. To resolve the issue, please log in to your Developer account at [developer.apple.com](https://developer.apple.com) and then click on "Certificates, Identifiers & Profiles". Under that screen, you will see "Development" under the "Certificates" section in the column on the left. You will need to click on the certificates, and choose "revoke" from the options that show after you click on the certificate. Confirm the warning message that will appear asking "Do you want to revoke the certificate?"
**Solution:** This error message has recently started to appear for some new Loop builders. To resolve the issue, please log in to your Developer account at [developer.apple.com](https://developer.apple.com){: target="_blank" } and then click on "Certificates, Identifiers & Profiles". Under that screen, you will see "Development" under the "Certificates" section in the column on the left. You will need to click on the certificates, and choose "revoke" from the options that show after you click on the certificate. Confirm the warning message that will appear asking "Do you want to revoke the certificate?"

![img/revoke1.png](img/revoke1.png){width="750"}
{align="center"}
Expand Down
8 changes: 4 additions & 4 deletions docs/build/cgm.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If the Dexcom app is on the same device as the *Loop* app, your system can funct

!!! warning "Dexcom G5 Support"

[Dexcom has stopped supporting the G5 system in the US](https://www.dexcom.com/obsolescence). In the US, and some other countries, the G5 is not available for download from the Apple Store. There are countries in which Dexcom does supply and support G5. The G5 capability will continue to be supported in Loop.
[Dexcom has stopped supporting the G5 system in the US](https://www.dexcom.com/obsolescence){: target="_blank" }. In the US, and some other countries, the G5 is not available for download from the Apple Store. There are countries in which Dexcom does supply and support G5. The G5 capability will continue to be supported in Loop.

There are third party apps, which interface with G4 and G5 transmitters, supported by some forks of Loop. The version of the *Loop* app supported by these documents only works with the Dexcom apps.

Expand Down Expand Up @@ -70,10 +70,10 @@ Version 3 or later of the *Loop* app can use Nightscout as a remote source for C

Libre Support (for some Libre sensors) is available with Loop-dev or by adding customizations.

* [Loop dev](../version/build-dev.md) adds [LibreTransmitter](https://github.com/dabear/LibreTransmitter#libretransmitter-for-loop)
* [`Loop and Learn: Loop Customization`](https://www.loopandlearn.org/custom-code/)
* [Loop dev](../version/build-dev.md) adds [LibreTransmitter](https://github.com/dabear/LibreTransmitter#libretransmitter-for-loop){: target="_blank" }
* [`Loop and Learn: Loop Customization`](https://www.loopandlearn.org/custom-code/){: target="_blank" }

Currently, there are no solutions for *Eversense*, *Guardian* or *Libre 3* CGM to be used directly with the *Loop* app, but some [Uploaders](https://nightscout.github.io/uploader/uploaders/) to Nightscout are available using an Android phone. Version 3 or later of the *Loop* app allows the use of Nightscout as a CGM source.
Currently, there are no solutions for *Eversense*, *Guardian* or *Libre 3* CGM to be used directly with the *Loop* app, but some [Uploaders](https://nightscout.github.io/uploader/uploaders/){: target="_blank" } to Nightscout are available using an Android phone. Version 3 or later of the *Loop* app allows the use of Nightscout as a CGM source.

## Next Step

Expand Down
2 changes: 1 addition & 1 deletion docs/build/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Volunteers provide assistance on building and using the *Loop* app at these site

Note, the *LoopDocs* menus were reorganized after this video was prepared to make it easier to progress through the pages.

[![img/looped-group.png](img/looped-group.png)](https://youtu.be/_vSN6C-Uo04)
[![img/looped-group.png](img/looped-group.png)](https://youtu.be/_vSN6C-Uo04){: target="_blank" }

## Screenshots

Expand Down
4 changes: 2 additions & 2 deletions docs/build/computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
If you do not have a Mac, you can build&nbsp;<span translate="no">Loop 3</span>&nbsp;with any computer using a browser. If you want to use that method, review this list and head over to [Build with Browser](../gh-actions/gh-overview.md).

- You need a paid ($99/year)&nbsp;[<span translate="no">Apple Developer Account</span>](apple-developer.md)
- You need an account (free) with&nbsp;[<span translate="no">GitHub</span>](https://github.com)
- You need an account (free) with&nbsp;[<span translate="no">GitHub</span>](https://github.com){: target="_blank" }
- You need a [compatible phone](phone.md) to install the app from *TestFlight*
- You need a [compatible Pump](pump.md) and [CGM](cgm.md) if you want to actually use the app (and not just explore the app)

Expand Down Expand Up @@ -99,7 +99,7 @@ Ventura is required for building the *Loop* app on a phone running iOS 16.4 or h
* iMac Pro
* Mac Studio
* Mac Pro introduced in 2019 or later
* get the full list from [Apple for Ventura](https://support.apple.com/kb/HT213264)
* get the full list from [Apple for Ventura](https://support.apple.com/kb/HT213264){: target="_blank" }

## Older Macs

Expand Down
10 changes: 5 additions & 5 deletions docs/build/custom-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ These customizations require you to modify the code used to build the *Loop* app

Some customizations are the same for everyone and have been prepared for easy use.

The *Loop and Learn* team commit to maintaining these prepared customizations and provide an easy method to add your selection from these customization to your version of *Loop*.
The *Loop and Learn* team is committed to maintaining these prepared customizations and provides an easy method to add your selection from these customizations to your version of *Loop*.

Please read the documentation for these on the [Loop and Learn: Customization Select Page](https://www.loopandlearn.org/custom-code):
Please read the documentation for these on the [Loop and Learn: Customization Select Page](https://www.loopandlearn.org/custom-code){: target="_blank" }:

* [List of Customizations Available](https://www.loopandlearn.org/custom-code/#custom-list)
* [Customization Select Script](https://www.loopandlearn.org/custom-code/#customization-select)
* [List of Customizations Available](https://www.loopandlearn.org/custom-code/#custom-list){: target="_blank" }
* [Customization Select Script](https://www.loopandlearn.org/custom-code/#customization-select){: target="_blank" }

### Add Libre Support to 3.2.3

If you are using `main` branch to build `Loop 3.2.3` and rely on either *xDrip4iOS* or *GlucoseDirect* to read your CGM and transfer the readings to the *Loop* app, you need to review this [section of the *Loop and Learn* customization page](https://www.loopandlearn.org/custom-code/#add-cgm-323).
If you are using `main` branch to build `Loop 3.2.3` and rely on either *xDrip4iOS* or *GlucoseDirect* to read your CGM and transfer the readings to the *Loop* app, you need to review this [section of the *Loop and Learn* customization page](https://www.loopandlearn.org/custom-code/#add-cgm-323){: target="_blank" }.

Alternatively, you can switch to the `dev` branch, which already supports Libre. [Build Loop dev with Mac](build-dev-mac.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/edit-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Each customization will also show Module, Folder and File bullet below the key p

## Open a Terminal in LoopWorkspace Folder

If you use the [Loop and Learn: Customization Select Script](https://www.loopandlearn.org/custom-code), it automatically locates your most recent download, makes the customization you select in that download and then opens Xcode for you.
If you use the [Loop and Learn: Customization Select Script](https://www.loopandlearn.org/custom-code){: target="_blank" }, it automatically locates your most recent download, makes the customization you select in that download and then opens Xcode for you.

But sometimes, you need to find your downloaded code and make your own changes in Xcode. This section tells you how to do this.

Expand Down
2 changes: 1 addition & 1 deletion docs/build/health.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Health Data

The Loop app uses the Health app to record blood glucose, insulin, and carbohydrate data. The blood glucose, insulin, and carbohydrate data stored in the Health app can also be accessed and uploaded by the [Tidepool](https://tidepool.org) Mobile app which enables display on of your data on the Tidepool web-based display tool. Please review the settings below to ensure you have the proper settings.
The Loop app uses the Health app to record blood glucose, insulin, and carbohydrate data. The blood glucose, insulin, and carbohydrate data stored in the Health app can also be accessed and uploaded by the [Tidepool](https://tidepool.org){: target="_blank" } Mobile app which enables the display of your data on the Tidepool web-based display tool. Please review the settings below to ensure you have the proper settings.

## Loop Permissions

Expand Down
Loading

0 comments on commit 902483b

Please sign in to comment.