Skip to content

Commit adb4cd3

Browse files
authored
Merge pull request nightscout#209 from tmhastings/build-dev
Add Recommendation to Build Dev
2 parents 754fe8d + 4160ce1 commit adb4cd3

8 files changed

Lines changed: 33 additions & 18 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Repository for [Trio documentation (under development)](https://triodocs.org)
1+
Repository for [Trio documentation (under development)](https://triodocs.org)
22

33
## Install
44

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1+
!!! important "Attention Trio Users"
2+
At this time all users should [build the dev branch](install/build/browser/build-dev-with-browser.md) rather than the main branch. We are in the process of merging dev into main. Once that is complete, you will be able to build main again.
3+
4+
Please read the [Migration Guide](configuration/migration/trio-02x-migration.md) before updating.
5+
16
!!! important "🚧 Documentation Under Construction 🚧"
27

38
This documentation is being released while still under construction. Please, keep in mind the following information:
49

5-
- This documentation is for the open testing branch of Trio (`dev` branch). Please review this documentation in preparation for testing Trio 0.5 or newer now that it is publicly available.
10+
- This documentation is for the `dev` branch of Trio. Please review this documentation in preparation for using Trio 0.5 or newer.
611
- If you are looking for the Trio 0.2.x (`main` branch) documentation, you can still find it here: [0.2.x](0.2.x/index.md)
12+
- Please note that Trio 0.2.x is no longer being maintained and we advise all users to move to the `dev` branch.
713
- Any page with a ✏️ indicates the information has not yet been updated. The information on those pages should not be referenced at this time.
814
- We welcome assistance with proofreading, editing, and updating the information in this documentation. If you would like to contribute to the documentation, please submit issues or PRs [here](https://github.com/nightscout/trio-docs)
915
- New educational videos are coming soon.

docs/install/build/browser/browser-build-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Congratulations on choosing to build Trio using your web browser, aka "Browser Build." This documentation provides all the necessary instructions to
44

55
!!! tip "🚧Documentation Under Construction🚧"
6-
The Browser Build instructions are still under construction. The steps to build with the browser are overall unchanged from Loop and Trio 0.2.x, so temporarily we advise you to use the [Loopdocs guidance for browser build](https://loopkit.github.io/loopdocs/browser/bb-update/), but replace the Loop GitHub repo with the Trio beta repo.
6+
The Browser Build instructions are still under construction. The steps to build with the browser are overall unchanged from Loop and Trio 0.2.x, so temporarily we advise you to use the [Loopdocs guidance for browser build](https://loopkit.github.io/loopdocs/browser/bb-update/), but replace the Loop GitHub repo with the Trio repo.
77

88
**Requirements:**
99

docs/install/build/browser/build-dev-with-browser.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
## Use Browser Build for Public Beta Version
1+
## Use Browser Build for Latest Trio
22

33
This page is provided to help people currently running the public beta version of Trio.
44

5-
!!! important "Public Beta"
5+
!!! important "Dev Branch"
66

7-
The public beta is built from the `dev` branch of Trio.
8-
9-
This code is undergoing testing and receives rapid updates. Be sure to follow along in Trio Discord and to update frequently (at least weekly).
7+
It is now recommended to use the `dev` branch of Trio.
108

119
* [Trio Discord Invitation](https://discord.triodocs.org)
1210

docs/install/build/mac/build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@
2121

2222
## Build Trio with Xcode
2323

24-
!!! important "Public Beta"
24+
!!! important "Dev Branch"
2525

26-
The public beta is built from the `dev` branch of Trio.
27-
28-
This code is undergoing testing and receives rapid updates. Be sure to follow along in Trio Discord and to download the latest code and update frequently (at least weekly).
26+
At this time all users should build the dev branch rather than the main branch. We are in the process of merging dev into main. Once that is complete, you will be able to build main again.
2927

30-
* [Trio Discord Invitation](https://discord.triodocs.org)
28+
Please read the [Migration Guide](../../../configuration/migration/trio-02x-migration.md) before updating.
29+
30+
This code is undergoing testing and receives rapid updates. Be sure to follow along in [Trio Discord](https://discord.triodocs.org) and to download the latest code and update frequently (at least weekly).
3131

3232
### Download Trio with 'Trio Build Select Script'
3333

@@ -66,11 +66,11 @@ The Trio Build Select Script is designed to walk you through downloading Trio. P
6666
![Screenshot: Build Select Script 2](img/xc-bs2.png){width="682"}
6767
{align= "center"}
6868
69-
5. Next, the script will prompt you to select which Trio branch you want to download. Unless you are actively contributing to app development by running the public beta, you will type 1 and press return.
69+
5. Next, the script will prompt you to select which Trio branch you want to download. Type 1 and press return.
7070
71-
!!! important "Public Beta"
71+
!!! important "Dev Branch"
7272
73-
To build the public beta, select 2 at this point to select the `dev` branch. Follow along in Trio discord and be sure to download a new version of code and build an update frequently (at least weekly).
73+
Until the `main` branch gets updated past 0.2.x, it is recommended all users build the `dev` branch instead of `main`.
7474
7575
![Screenshot: Build Select Script 3](img/xc-bs3.png){width="682"}
7676
{align= "center"}
23.4 KB
Loading

docs/install/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Welcome to the installation and update homepage! Here you will find information
88

99
Please use the navigation menu :fontawesome-solid-bars:, search bar :fontawesome-solid-magnifying-glass:, or the menu below to find the section you are looking for.
1010

11+
!!! important "Attention Trio Users"
12+
At this time all users should [build the dev branch](build/browser/build-dev-with-browser.md) rather than the main branch. We are in the process of merging dev into main. Once that is complete, you will be able to build main again.
13+
14+
Please read the [Migration Guide](../configuration/migration/trio-02x-migration.md) before updating.
15+
1116
<div class="grid cards" markdown>
1217

1318
- __App Requirements__
@@ -23,12 +28,18 @@ Please use the navigation menu :fontawesome-solid-bars:, search bar :fontawesome
2328

2429
Overview on building Trio using a Mac computer and Xcode
2530

31+
- __[Build Dev with Browser](build/browser/build-dev-with-browser.md)__
32+
33+
- - -
34+
35+
Overview on building Trio dev branch using a web browser and TestFlight
36+
2637
- __[Build with Browser ✏️](build/browser/browser-build-overview.md)__
2738

2839
- - -
2940

3041
🚧Documentation Under Construction🚧
31-
Overview on building Trio using a web browser and Test Flight
42+
Overview on building Trio using a web browser and TestFlight
3243

3344
- __[Upgrade ✏️](upgrade.md)__
3445

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ nav:
254254
- Build Trio with Xcode: install/build/mac/build.md
255255
- Build Errors: install/build/mac/build-errors.md
256256
- Update Trio with Xcode: install/build/mac/update.md
257-
- Build Beta with Browser: install/build/browser/build-dev-with-browser.md
257+
- Build Dev with Browser: install/build/browser/build-dev-with-browser.md
258258
- Build with Browser ✏️:
259259
- Browser Build Overview ✏️: install/build/browser/browser-build-overview.md
260260
- Create GitHub Account ✏️: install/build/browser/create-github-account.md

0 commit comments

Comments
 (0)