diff --git a/docs/img/search_example.png b/docs/img/search_example.png new file mode 100644 index 00000000000..ba7728f22a8 Binary files /dev/null and b/docs/img/search_example.png differ diff --git a/docs/img/search_icon.png b/docs/img/search_icon.png new file mode 100644 index 00000000000..3d2b1291d30 Binary files /dev/null and b/docs/img/search_icon.png differ diff --git a/docs/index.md b/docs/index.md index aed640c2e49..dda76a4ad02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,12 +9,16 @@ The app is built on top of [LoopKit](https://github.com/LoopKit/LoopKit). LoopKit is a set of frameworks that provide data storage, retrieval, and calculation, as well as boilerplate view controllers used in Loop. -Please understand that this project: +!!!warning "Important" -- Is highly experimental -- Is not approved for therapy + Please understand that this project: -Using the open source Loop app template, you can build an insulin delivery system that uses specific commercial and open source hardware and software technologies to bring together the insulin pump, continuous glucose monitor (CGM), and insulin dosing algorithm to create a continuous insulin basal dosing “Loop”. This Loop predicts future glucose based on basal-rate schedules, carbohydrate intake, insulin on board, and current CGM readings. These glucose forecasts provide Loop with the information needed to recommend a temporary basal rate to attain a targeted glucose range in the future. The system can either operate as an “open loop” by making recommendations to the user for their approval before enacting or as a “closed loop” by automatically setting the recommended temporary basal rate. *You take full responsibility for building and running this system and do so at your own risk.* + - Is highly experimental + - Is not approved for therapy + + **You take full responsibility for building and running this system and do so at your own risk.** + +Using the open source Loop app template, you can build an insulin delivery system that uses specific commercial and open source hardware and software technologies to bring together the insulin pump, continuous glucose monitor (CGM), and insulin dosing algorithm to create a continuous insulin basal dosing “Loop”. This Loop predicts future glucose based on basal-rate schedules, carbohydrate intake, insulin on board, and current CGM readings. These glucose forecasts provide Loop with the information needed to recommend a temporary basal rate to attain a targeted glucose range in the future. The system can either operate as an “open loop” by making recommendations to the user for their approval before enacting or as a “closed loop” by automatically setting the recommended temporary basal rate. You should undertake this project in stages. For example, first “open loop” to familiarize yourself with Loop’s operation. Also, investigate the code to ensure you understand what it is recommending and why. Then when you progress to “closed loop”, do so safely by starting with appropriate safety limits and only progress to higher limits after several days of no lows. Please ask questions at this point about why Loop is making the recommendations it does. It should be similar to the therapy decisions you would make yourself. If the recommendations it makes are different than you would make, try to figure out why. @@ -22,6 +26,16 @@ You should undertake this project in stages. For example, first “open loop” Loop has been developed as an open-source, shared project. For a really interesting read about the history of Loop development, check out this [History of Loop and LoopKit](https://medium.com/@loudnate/the-history-of-loop-and-loopkit-59b3caf13805) post, written by Loop developer Nate Racklyeft. The project continues to be a labor-of-love by a community of users; maintained and improved by volunteers. + +## How to Use These Docs + +* Use the navigation menu at the top of the screen to find the info you are looking for. +* A Table of Contents for the current page is always displayed on the left side of the screen. +* You can search the Loop Docs site by clicking the icon. + + + + ## Stay in the Loop! [Sign up for the Loop Users announcement list](https://groups.google.com/forum/#!forum/loop-ios-users) to stay informed of critical issues that may arise. @@ -32,4 +46,4 @@ There is also a [Looped Facebook Group](https://www.facebook.com/groups/TheLoope ## Contribute -Please consider submitting any updates and improvements to the docmentation that you want to share by submitting PRs to the [loopdocs repo](https://github.com/LoopKit/loopdocs). Also, read the [LICENSE](https://github.com/LoopKit/Loop/blob/master/LICENSE.md) and [CODE_OF_CONDUCT](https://github.com/LoopKit/Loop/blob/master/CODE_OF_CONDUCT.md). +Please consider submitting any updates and improvements to the docmentation that you want to share by submitting a Pull Request to the [loopdocs repo](https://github.com/LoopKit/loopdocs). For more information on how to contribute to an open source project, this [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) guide may be useful. Also, please review the Loop [LICENSE](https://github.com/LoopKit/Loop/blob/master/LICENSE.md) and Loop [CODE_OF_CONDUCT](https://github.com/LoopKit/Loop/blob/master/CODE_OF_CONDUCT.md).