Merge remote-tracking branch 'upstream/dev' into config/git_and_pytho…

…n_packages

README.md

@@ -1,13 +1,58 @@
 Repository for [Trio documentation (under development)](https://docs.diy-trio.org)
 
+## Install
+
+- [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) this project
+- Install *Python* 3
+  Review [Properly Installing Python](http://docs.python-guide.org/en/latest/starting/installation/) for help on getting *Python* installed.
+- Install a Python Virtual Environment.  
+  In this example, I use [`venv`](https://realpython.com/python-virtual-environments-a-primer/#how-can-you-work-with-a-python-virtual-environment), but use whichever you prefer.
+
+```shell
+cd trio-docs # cd into the folder where you cloned this repository
+
+# Creates a virtual environment using Python 3 in the venv folder
+python3 -m venv venv
+
+# Activate the virtual environment
+# Run the next line **each time** you start a new shell window/tab
+source venv/bin/activate
+
+# Make sure you are in the folder where you cloned this repository, if not:
+# cd trio-docs
+
+# To build and preview the site locally (hot-reload the pages in the Web browser)
+python -m pip install sphinx-autobuild
+
+# Install the project's required packages
+python -m pip install -r requirements.txt
+```
+
+## Run
+
+Once [installed](#install), you can preview the doc locally as you edit.
+
+### Preview Changes Locally
+
+To preview your work as you edit, run this command in a separate terminal window/tab and do not interrupt it:
+
+  ```shell
+  # cd trio-docs # cd where you cloned this repository
+
+  sphinx-autobuild docs/EN docs/_build/html
+  ```
+
+  This builds the site locally and **runs a local Web server** on http://127.0.0.1:8000  
+  It also rebuilds the site when you change a file and hot refreshes the browser so that you can see the changes.
+
 ## Tips & Tricks
 
-> [!NOTE] 
+> [!NOTE]
 > Please add!
 
 ### Add a Chapter
 
-Using the `#` sign shows a chapter on the menu/index. The amount of `#`'s determines the level. 
+Using the `#` sign shows a chapter on the menu/index. The amount of `#`'s determines the level.
 
 **Example**:
 
@@ -21,15 +66,16 @@ Using the `#` sign shows a chapter on the menu/index. The amount of `#`'s determ
 ### Link to Another File
 ```
 
-> [!TIP] 
+> [!TIP]
 > If you want to avoid a chapter ending up in the menu/index, use bold text by:
-> - either surrounding the text with 2-star signs `**` 
-> - or adding `<b>` before the text and `</b>` after the text (without spaces).  
-> 
-> Input              | Result        
-> ------------------ | ------------- 
-> `**bold text**`    | **bold text** 
->  `<b>bold text</b>` | **bold text** 
+>
+> - either surrounding the text with 2-star signs `**`
+> - or adding `<b>` before the text and `</b>` after the text (without spaces).
+>
+> | Input              | Result        |
+> | ------------------ | ------------- |
+> | `**bold text**`    | **bold text** |
+> | `<b>bold text</b>` | **bold text** |
 
 ### Link to Another File
 

dev-requirements.in

@@ -0,0 +1 @@
+sphinx-autobuild

docs/EN/Setup/New-User-Setup.md

@@ -30,8 +30,9 @@ Once you have verified that you are using compatible devices, you can connect th
 ## Step 2: Add Profile Settings
 The next step is to enter your main profile settings: Basal, ISF, CR, and Target Glucose.
 
-:::{important}
-If you use mg/dL, you must first change the 'Glucose Units' before entering your profile settings.
+:::{admonition} Important
+:class: important
+If you use `mg/dL`, you must first change the `Glucose Units` **before** entering your profile settings.
 
 This is found in the Trio Settings menu under 'Preferences'
 :::
@@ -45,15 +46,14 @@ This is found in the Trio Settings menu under 'Preferences'
 ## Step 3: Adjust Safety Limits
 The next step is to adjust the standard safety limits that will allow Trio to function effectively. There are many more settings that are not mentioned in this section. It is not advised to adjust those until you have familiarized yourself with the system by using it for a while.
 
-:::{warning}
-<b>DO NOT ENABLE DYNAMIC SETTINGS YET</b>
+:::{admonition} DO NOT ENABLE DYNAMIC SETTINGS YET
+:class: warning
 
 It is essential that Trio have enough data to make sound recommendations. It is essential that your settings are tuned to be used in an Oref algorithm and you feel comfortable using the Trio app. It is not recommended to enable dynamic settings until ALL criteria below are met:
 
  - You are confident that your ISF, CR, and Basal Rates are tuned for use in the Oref algorithm
  - You have used Trio with a real CGM and real pump (not simulators) for the recommended minimum of 7 consecutive days
  - You are comfortable with the Trio app
-
 :::
 
  1. [Recommended Bolus Percentage](../settings/configuration/preferences/trio.md#recommended-bolus-percentage)

docs/EN/index.md

@@ -159,5 +159,7 @@ Sensitivity Settings <./settings/configuration/preferences/targetsettings.md>
 
 Citations <./resources/citations.md>
 
+Translation <./resources/translate.md>
+
 ```