Merge pull request #1686 from peterleimbach/master

new introduction section from the rework project
openaps · Sep 9, 2023 · 80ed61d · 80ed61d
2 parents eadf0ff + 509b13e
commit 80ed61d
Show file tree

Hide file tree

Showing 9 changed files with 338 additions and 19 deletions.
diff --git a/docs/EN/images/AAPS-connectivity-no-followers.png b/docs/EN/images/AAPS-connectivity-no-followers.png
diff --git a/docs/EN/images/AAPS-overview-with-followers.png b/docs/EN/images/AAPS-overview-with-followers.png
diff --git a/docs/EN/images/FRONTIERS_Logo_Grey_RGB.png b/docs/EN/images/FRONTIERS_Logo_Grey_RGB.png
diff --git a/docs/EN/images/available.png b/docs/EN/images/available.png
diff --git a/docs/EN/images/basic-outline-of-AAPS.png b/docs/EN/images/basic-outline-of-AAPS.png
diff --git a/docs/EN/images/basic-overview-mdi-open-and-closed-loop.png b/docs/EN/images/basic-overview-mdi-open-and-closed-loop.png
diff --git a/docs/EN/images/unavailable.png b/docs/EN/images/unavailable.png
diff --git a/docs/EN/index.md b/docs/EN/index.md
@@ -2,21 +2,28 @@
 
 ![Image](images/modules-female.png)
 
-AAPS is an open source app for people living with insulin-dependent diabetes that acts as an artificial pancreas system (APS) on Google Android smartphones. The main components are different openAPS software algorithms which aim to do what a living pancreas does: keeping blood sugar levels within healthy limits by using automated insulin dosing (AID). Additionally, you need at least a supported and FDA/CE approved insulin pump and continuous glucose meter.
+AAPS is an open source app for people living with insulin-dependent diabetes that acts as an artificial pancreas system (APS) on Google Android smartphones. It uses an openAPS software algorithm which aims to do what a living pancreas does: keeping blood sugar levels within healthy limits by using automated insulin dosing (AID). Additionally, you need a supported and FDA/CE approved insulin pump, and a continuous glucose meter.
 
-The app does *not* use self-learning artificial intelligence. Instead, the calculations of AAPS are based on the individual dosage algorithm and carbohydrate intake the user manually puts into their treatments profile, but they are verified by the system for safety reasons.
+Interested? Read more about AAPS in the [introduction](introduction.md).
 
-The app is not provided in Google Play - you have to build it from source code by yourself for legal reasons.
+```{warning}
+**IMPORTANT SAFETY NOTICE**
 
-```{admonition} Ask for help - Writing Docs
-:class: note
+The foundation of AAPS safety features discussed in this documentation is built on the safety features of the hardware used to build your system. It is critically important that you only use a tested, fully functioning FDA or CE approved insulin pump and CGM for closing an automated insulin dosing loop. Hardware or software modifications to these components can cause unexpected insulin dosing, causing significant risk to the user. If you find or get offered broken, modified or self-made insulin pumps or CGM receivers, *do not use* these for creating an AAPS system.
 
-Please don't be shy, we urgently *need* support in creating the documentation.
+Additionally, it is equally important to only use original supplies such as inserters, cannulas and insulin containers approved by the manufacturer for use with your pump or CGM. Using untested or modified supplies can cause CGM inaccuracy and insulin dosing errors. Insulin is highly dangerous when misdosed - please do not play with your life by hacking with your supplies.
 
-A pull request to edit the documentation is relatively simple to create. You can't break anything. There are release procedures.
+Last not least, you must not take SGLT-2 inhibitors (gliflozins) as they incalculably lower blood sugar levels.  The combination with a system that lowers basal rates in order to increase BG is especially dangerous as due to the gliflozin this rise in BG might not happen and a dangerous state of lack of insulin can happen.
+```
 
-A 3 minute video which explains how to edit the docs via PR is available [here](https://www.youtube.com/watch?v=Vo4L6YYxWak).
+```{note}
+**Disclaimer and Warning**
 
+- All information, thought, and code described here is intended for informational and educational purposes only. Nightscout currently makes no attempt at HIPAA privacy compliance. Use Nightscout and AAPS at your own risk, and do not use the information or code to make medical decisions.
+- Use of code from github.com is without warranty or formal support of any kind. Please review this repository's LICENSE for details.
+- All product and company names, trademarks, servicemarks, registered trademarks, and registered servicemarks are the property of their respective holders. Their use is for information purposes and does not imply any affiliation with or endorsement by them.
+
+Please note - this project has no association with and is not endorsed by: [SOOIL](http://www.sooil.com/eng/), [Dexcom](https://www.dexcom.com/), [Accu-Chek, Roche Diabetes Care](https://www.accu-chek.com/), [Insulet](https://www.insulet.com/) or [Medtronic](https://www.medtronic.com/).
 ```
 
 ## How to read the documentation?
@@ -47,23 +54,17 @@ There is a subsection for the [clinicians](Resources/clinician-guide-to-AAPS.md)
 
 Finally, in the subsection [How to help?](make-a-PR.md) we would like to provide you with information so that you are able to suggest small or larger changes to the documentation yourself and work together with us on the documentation. We further need support for [translation of the documentation](translations.md) By the way, it also very helpful for everyone if you could provide links to the corresponding documentation (or screenshots of where the links are located within the Documentation if you are not familiar with how to send a link) when answering questions from other users. That way the correct information can easily be located again should other users also be trying to find answers to the same types of questions in the future.
 
-(index-translation-help-needed)=
-
-```{admonition} Ask for help - Translators Neeeded!!!
-:class: note
-
-The documentation is written in English and translated in different languages. We are searching help by the translation of a) the app and b) the documentation.
-
-The translation process is explained [here](translations.md).
+```{toctree}
+:caption: Change language
 
-The state of the translations per language for app and documentation can be found [here](./Administration/stateTranslations.md).
+Change language <./changelanguage.md>
 
 ```
 
 ```{toctree}
-:caption: Change language
+:caption: Home
 
-Change language <./changelanguage.md>
+Introduction <introduction.md>
 
 ```